« blib/lib/Paws/ACMPCA/CertificateAuthorityConfiguration.pm
↑ Summary
blib/lib/Paws/ACMPCA/CreateCertificateAuthorityAuditReport.pm »
| 1 | |||
| 2 | package Paws::ACMPCA::CreateCertificateAuthority; | ||
| 3 | use Moose; | ||
| 4 | has CertificateAuthorityConfiguration => (is => 'ro', isa => 'Paws::ACMPCA::CertificateAuthorityConfiguration', required => 1); | ||
| 5 | has CertificateAuthorityType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has IdempotencyToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has KeyStorageSecurityStandard => (is => 'ro', isa => 'Str'); | ||
| 8 | has RevocationConfiguration => (is => 'ro', isa => 'Paws::ACMPCA::RevocationConfiguration'); | ||
| 9 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ACMPCA::Tag]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCertificateAuthority'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ACMPCA::CreateCertificateAuthorityResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::ACMPCA::CreateCertificateAuthority - Arguments for method CreateCertificateAuthority on L<Paws::ACMPCA> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method CreateCertificateAuthority on the | ||
| 27 | L<AWS Certificate Manager Private Certificate Authority|Paws::ACMPCA> service. Use the attributes of this class | ||
| 28 | as arguments to method CreateCertificateAuthority. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCertificateAuthority. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $acm-pca = Paws->service('ACMPCA'); | ||
| 35 | my $CreateCertificateAuthorityResponse = | ||
| 36 | $acm -pca->CreateCertificateAuthority( | ||
| 37 | CertificateAuthorityConfiguration => { | ||
| 38 | KeyAlgorithm => | ||
| 39 | 'RSA_2048', # values: RSA_2048, RSA_4096, EC_prime256v1, EC_secp384r1 | ||
| 40 | SigningAlgorithm => 'SHA256WITHECDSA' | ||
| 41 | , # values: SHA256WITHECDSA, SHA384WITHECDSA, SHA512WITHECDSA, SHA256WITHRSA, SHA384WITHRSA, SHA512WITHRSA | ||
| 42 | Subject => { | ||
| 43 | CommonName => 'MyString64', # max: 64; OPTIONAL | ||
| 44 | Country => 'MyCountryCodeString', # min: 2, max: 2; OPTIONAL | ||
| 45 | DistinguishedNameQualifier => | ||
| 46 | 'MyASN1PrintableString64', # max: 64; OPTIONAL | ||
| 47 | GenerationQualifier => 'MyString3', # max: 3; OPTIONAL | ||
| 48 | GivenName => 'MyString16', # max: 16; OPTIONAL | ||
| 49 | Initials => 'MyString5', # max: 5; OPTIONAL | ||
| 50 | Locality => 'MyString128', # max: 128; OPTIONAL | ||
| 51 | Organization => 'MyString64', # max: 64; OPTIONAL | ||
| 52 | OrganizationalUnit => 'MyString64', # max: 64; OPTIONAL | ||
| 53 | Pseudonym => 'MyString128', # max: 128; OPTIONAL | ||
| 54 | SerialNumber => 'MyASN1PrintableString64', # max: 64; OPTIONAL | ||
| 55 | State => 'MyString128', # max: 128; OPTIONAL | ||
| 56 | Surname => 'MyString40', # max: 40; OPTIONAL | ||
| 57 | Title => 'MyString64', # max: 64; OPTIONAL | ||
| 58 | }, | ||
| 59 | CsrExtensions => { | ||
| 60 | KeyUsage => { | ||
| 61 | CRLSign => 1, # OPTIONAL | ||
| 62 | DataEncipherment => 1, # OPTIONAL | ||
| 63 | DecipherOnly => 1, # OPTIONAL | ||
| 64 | DigitalSignature => 1, # OPTIONAL | ||
| 65 | EncipherOnly => 1, # OPTIONAL | ||
| 66 | KeyAgreement => 1, # OPTIONAL | ||
| 67 | KeyCertSign => 1, # OPTIONAL | ||
| 68 | KeyEncipherment => 1, # OPTIONAL | ||
| 69 | NonRepudiation => 1, # OPTIONAL | ||
| 70 | }, # OPTIONAL | ||
| 71 | SubjectInformationAccess => [ | ||
| 72 | { | ||
| 73 | AccessLocation => { | ||
| 74 | DirectoryName => { | ||
| 75 | CommonName => 'MyString64', # max: 64; OPTIONAL | ||
| 76 | Country => 'MyCountryCodeString', # min: 2, max: 2; OPTIONAL | ||
| 77 | DistinguishedNameQualifier => | ||
| 78 | 'MyASN1PrintableString64', # max: 64; OPTIONAL | ||
| 79 | GenerationQualifier => 'MyString3', # max: 3; OPTIONAL | ||
| 80 | GivenName => 'MyString16', # max: 16; OPTIONAL | ||
| 81 | Initials => 'MyString5', # max: 5; OPTIONAL | ||
| 82 | Locality => 'MyString128', # max: 128; OPTIONAL | ||
| 83 | Organization => 'MyString64', # max: 64; OPTIONAL | ||
| 84 | OrganizationalUnit => 'MyString64', # max: 64; OPTIONAL | ||
| 85 | Pseudonym => 'MyString128', # max: 128; OPTIONAL | ||
| 86 | SerialNumber => 'MyASN1PrintableString64', # max: 64; OPTIONAL | ||
| 87 | State => 'MyString128', # max: 128; OPTIONAL | ||
| 88 | Surname => 'MyString40', # max: 40; OPTIONAL | ||
| 89 | Title => 'MyString64', # max: 64; OPTIONAL | ||
| 90 | }, | ||
| 91 | DnsName => 'MyString253', # max: 253; OPTIONAL | ||
| 92 | EdiPartyName => { | ||
| 93 | PartyName => 'MyString256', # max: 256 | ||
| 94 | NameAssigner => 'MyString256', # max: 256 | ||
| 95 | }, # OPTIONAL | ||
| 96 | IpAddress => 'MyString39', # max: 39; OPTIONAL | ||
| 97 | OtherName => { | ||
| 98 | TypeId => 'MyCustomObjectIdentifier', # max: 64 | ||
| 99 | Value => 'MyString256', # max: 256 | ||
| 100 | |||
| 101 | }, # OPTIONAL | ||
| 102 | RegisteredId => 'MyCustomObjectIdentifier', # max: 64 | ||
| 103 | Rfc822Name => 'MyString256', # max: 256 | ||
| 104 | UniformResourceIdentifier => 'MyString253', # max: 253; OPTIONAL | ||
| 105 | }, | ||
| 106 | AccessMethod => { | ||
| 107 | AccessMethodType => 'CA_REPOSITORY' | ||
| 108 | , # values: CA_REPOSITORY, RESOURCE_PKI_MANIFEST, RESOURCE_PKI_NOTIFY; OPTIONAL | ||
| 109 | CustomObjectIdentifier => 'MyCustomObjectIdentifier', # max: 64 | ||
| 110 | }, | ||
| 111 | |||
| 112 | }, | ||
| 113 | ... | ||
| 114 | ], # OPTIONAL | ||
| 115 | }, # OPTIONAL | ||
| 116 | }, | ||
| 117 | CertificateAuthorityType => 'ROOT', | ||
| 118 | IdempotencyToken => 'MyIdempotencyToken', # OPTIONAL | ||
| 119 | KeyStorageSecurityStandard => 'FIPS_140_2_LEVEL_2_OR_HIGHER', # OPTIONAL | ||
| 120 | RevocationConfiguration => { | ||
| 121 | CrlConfiguration => { | ||
| 122 | Enabled => 1, # OPTIONAL | ||
| 123 | CustomCname => 'MyString253', # max: 253; OPTIONAL | ||
| 124 | ExpirationInDays => 1, # min: 1, max: 5000; OPTIONAL | ||
| 125 | S3BucketName => 'MyString3To255', # min: 3, max: 255; OPTIONAL | ||
| 126 | S3ObjectAcl => 'PUBLIC_READ' | ||
| 127 | , # values: PUBLIC_READ, BUCKET_OWNER_FULL_CONTROL; OPTIONAL | ||
| 128 | }, # OPTIONAL | ||
| 129 | }, # OPTIONAL | ||
| 130 | Tags => [ | ||
| 131 | { | ||
| 132 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 133 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 134 | }, | ||
| 135 | ... | ||
| 136 | ], # OPTIONAL | ||
| 137 | ); | ||
| 138 | |||
| 139 | # Results: | ||
| 140 | my $CertificateAuthorityArn = | ||
| 141 | $CreateCertificateAuthorityResponse->CertificateAuthorityArn; | ||
| 142 | |||
| 143 | # Returns a L<Paws::ACMPCA::CreateCertificateAuthorityResponse> object. | ||
| 144 | |||
| 145 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 146 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/acm-pca/CreateCertificateAuthority> | ||
| 147 | |||
| 148 | =head1 ATTRIBUTES | ||
| 149 | |||
| 150 | |||
| 151 | =head2 B<REQUIRED> CertificateAuthorityConfiguration => L<Paws::ACMPCA::CertificateAuthorityConfiguration> | ||
| 152 | |||
| 153 | Name and bit size of the private key algorithm, the name of the signing | ||
| 154 | algorithm, and X.500 certificate subject information. | ||
| 155 | |||
| 156 | |||
| 157 | |||
| 158 | =head2 B<REQUIRED> CertificateAuthorityType => Str | ||
| 159 | |||
| 160 | The type of the certificate authority. | ||
| 161 | |||
| 162 | Valid values are: C<"ROOT">, C<"SUBORDINATE"> | ||
| 163 | |||
| 164 | =head2 IdempotencyToken => Str | ||
| 165 | |||
| 166 | Custom string that can be used to distinguish between calls to the | ||
| 167 | B<CreateCertificateAuthority> action. Idempotency tokens for | ||
| 168 | B<CreateCertificateAuthority> time out after five minutes. Therefore, | ||
| 169 | if you call B<CreateCertificateAuthority> multiple times with the same | ||
| 170 | idempotency token within five minutes, ACM Private CA recognizes that | ||
| 171 | you are requesting only certificate authority and will issue only one. | ||
| 172 | If you change the idempotency token for each call, PCA recognizes that | ||
| 173 | you are requesting multiple certificate authorities. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 KeyStorageSecurityStandard => Str | ||
| 178 | |||
| 179 | Specifies a cryptographic key management compliance standard used for | ||
| 180 | handling CA keys. | ||
| 181 | |||
| 182 | Default: FIPS_140_2_LEVEL_3_OR_HIGHER | ||
| 183 | |||
| 184 | Note: C<FIPS_140_2_LEVEL_3_OR_HIGHER> is not supported in Region | ||
| 185 | ap-northeast-3. When creating a CA in the ap-northeast-3, you must | ||
| 186 | provide C<FIPS_140_2_LEVEL_2_OR_HIGHER> as the argument for | ||
| 187 | C<KeyStorageSecurityStandard>. Failure to do this results in an | ||
| 188 | C<InvalidArgsException> with the message, "A certificate authority | ||
| 189 | cannot be created in this region with the specified security standard." | ||
| 190 | |||
| 191 | Valid values are: C<"FIPS_140_2_LEVEL_2_OR_HIGHER">, C<"FIPS_140_2_LEVEL_3_OR_HIGHER"> | ||
| 192 | |||
| 193 | =head2 RevocationConfiguration => L<Paws::ACMPCA::RevocationConfiguration> | ||
| 194 | |||
| 195 | Contains a Boolean value that you can use to enable a certification | ||
| 196 | revocation list (CRL) for the CA, the name of the S3 bucket to which | ||
| 197 | ACM Private CA will write the CRL, and an optional CNAME alias that you | ||
| 198 | can use to hide the name of your bucket in the B<CRL Distribution | ||
| 199 | Points> extension of your CA certificate. For more information, see the | ||
| 200 | CrlConfiguration | ||
| 201 | (https://docs.aws.amazon.com/acm-pca/latest/APIReference/API_CrlConfiguration.html) | ||
| 202 | structure. | ||
| 203 | |||
| 204 | |||
| 205 | |||
| 206 | =head2 Tags => ArrayRef[L<Paws::ACMPCA::Tag>] | ||
| 207 | |||
| 208 | Key-value pairs that will be attached to the new private CA. You can | ||
| 209 | associate up to 50 tags with a private CA. For information using tags | ||
| 210 | with IAM to manage permissions, see Controlling Access Using IAM Tags | ||
| 211 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html). | ||
| 212 | |||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | =head1 SEE ALSO | ||
| 217 | |||
| 218 | This class forms part of L<Paws>, documenting arguments for method CreateCertificateAuthority in L<Paws::ACMPCA> | ||
| 219 | |||
| 220 | =head1 BUGS and CONTRIBUTIONS | ||
| 221 | |||
| 222 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 223 | |||
| 224 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 225 | |||
| 226 | =cut | ||
| 227 |