« blib/lib/Paws/ACMPCA/ApiPassthrough.pm
↑ Summary
blib/lib/Paws/ACMPCA/CertificateAuthorityConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ACMPCA::CertificateAuthority; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str'); | ||
| 5 | has CertificateAuthorityConfiguration => (is => 'ro', isa => 'Paws::ACMPCA::CertificateAuthorityConfiguration'); | ||
| 6 | has CreatedAt => (is => 'ro', isa => 'Str'); | ||
| 7 | has FailureReason => (is => 'ro', isa => 'Str'); | ||
| 8 | has KeyStorageSecurityStandard => (is => 'ro', isa => 'Str'); | ||
| 9 | has LastStateChangeAt => (is => 'ro', isa => 'Str'); | ||
| 10 | has NotAfter => (is => 'ro', isa => 'Str'); | ||
| 11 | has NotBefore => (is => 'ro', isa => 'Str'); | ||
| 12 | has OwnerAccount => (is => 'ro', isa => 'Str'); | ||
| 13 | has RestorableUntil => (is => 'ro', isa => 'Str'); | ||
| 14 | has RevocationConfiguration => (is => 'ro', isa => 'Paws::ACMPCA::RevocationConfiguration'); | ||
| 15 | has Serial => (is => 'ro', isa => 'Str'); | ||
| 16 | has Status => (is => 'ro', isa => 'Str'); | ||
| 17 | has Type => (is => 'ro', isa => 'Str'); | ||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::ACMPCA::CertificateAuthority | ||
| 26 | |||
| 27 | =head1 USAGE | ||
| 28 | |||
| 29 | This class represents one of two things: | ||
| 30 | |||
| 31 | =head3 Arguments in a call to a service | ||
| 32 | |||
| 33 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 34 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 35 | |||
| 36 | As an example, if Att1 is expected to be a Paws::ACMPCA::CertificateAuthority object: | ||
| 37 | |||
| 38 | $service_obj->Method(Att1 => { Arn => $value, ..., Type => $value }); | ||
| 39 | |||
| 40 | =head3 Results returned from an API call | ||
| 41 | |||
| 42 | Use accessors for each attribute. If Att1 is expected to be an Paws::ACMPCA::CertificateAuthority object: | ||
| 43 | |||
| 44 | $result = $service_obj->Method(...); | ||
| 45 | $result->Att1->Arn | ||
| 46 | |||
| 47 | =head1 DESCRIPTION | ||
| 48 | |||
| 49 | Contains information about your private certificate authority (CA). | ||
| 50 | Your private CA can issue and revoke X.509 digital certificates. | ||
| 51 | Digital certificates verify that the entity named in the certificate | ||
| 52 | B<Subject> field owns or controls the public key contained in the | ||
| 53 | B<Subject Public Key Info> field. Call the CreateCertificateAuthority | ||
| 54 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CreateCertificateAuthority.html) | ||
| 55 | action to create your private CA. You must then call the | ||
| 56 | GetCertificateAuthorityCertificate | ||
| 57 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_GetCertificateAuthorityCertificate.html) | ||
| 58 | action to retrieve a private CA certificate signing request (CSR). Sign | ||
| 59 | the CSR with your ACM Private CA-hosted or on-premises root or | ||
| 60 | subordinate CA certificate. Call the | ||
| 61 | ImportCertificateAuthorityCertificate | ||
| 62 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_ImportCertificateAuthorityCertificate.html) | ||
| 63 | action to import the signed certificate into AWS Certificate Manager | ||
| 64 | (ACM). | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Arn => Str | ||
| 70 | |||
| 71 | Amazon Resource Name (ARN) for your private certificate authority (CA). | ||
| 72 | The format is C< I<12345678-1234-1234-1234-123456789012> >. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 CertificateAuthorityConfiguration => L<Paws::ACMPCA::CertificateAuthorityConfiguration> | ||
| 76 | |||
| 77 | Your private CA configuration. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 CreatedAt => Str | ||
| 81 | |||
| 82 | Date and time at which your private CA was created. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 FailureReason => Str | ||
| 86 | |||
| 87 | Reason the request to create your private CA failed. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 KeyStorageSecurityStandard => Str | ||
| 91 | |||
| 92 | Defines a cryptographic key management compliance standard used for | ||
| 93 | handling CA keys. | ||
| 94 | |||
| 95 | Default: FIPS_140_2_LEVEL_3_OR_HIGHER | ||
| 96 | |||
| 97 | Note: AWS Region ap-northeast-3 supports only | ||
| 98 | FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this | ||
| 99 | parameter and value when creating a CA in that Region. Specifying a | ||
| 100 | different value (or no value) results in an C<InvalidArgsException> | ||
| 101 | with the message "A certificate authority cannot be created in this | ||
| 102 | region with the specified security standard." | ||
| 103 | |||
| 104 | |||
| 105 | =head2 LastStateChangeAt => Str | ||
| 106 | |||
| 107 | Date and time at which your private CA was last updated. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 NotAfter => Str | ||
| 111 | |||
| 112 | Date and time after which your private CA certificate is not valid. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 NotBefore => Str | ||
| 116 | |||
| 117 | Date and time before which your private CA certificate is not valid. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 OwnerAccount => Str | ||
| 121 | |||
| 122 | The AWS account ID that owns the certificate authority. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 RestorableUntil => Str | ||
| 126 | |||
| 127 | The period during which a deleted CA can be restored. For more | ||
| 128 | information, see the C<PermanentDeletionTimeInDays> parameter of the | ||
| 129 | DeleteCertificateAuthorityRequest | ||
| 130 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_DeleteCertificateAuthorityRequest.html) | ||
| 131 | action. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 RevocationConfiguration => L<Paws::ACMPCA::RevocationConfiguration> | ||
| 135 | |||
| 136 | Information about the certificate revocation list (CRL) created and | ||
| 137 | maintained by your private CA. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 Serial => Str | ||
| 141 | |||
| 142 | Serial number of your private CA. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 Status => Str | ||
| 146 | |||
| 147 | Status of your private CA. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 Type => Str | ||
| 151 | |||
| 152 | Type of your private CA. | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head1 SEE ALSO | ||
| 157 | |||
| 158 | This class forms part of L<Paws>, describing an object used in L<Paws::ACMPCA> | ||
| 159 | |||
| 160 | =head1 BUGS and CONTRIBUTIONS | ||
| 161 | |||
| 162 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 163 | |||
| 164 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 165 | |||
| 166 | =cut | ||
| 167 |