| 1 | |||
| 2 | package Paws::ACM::RequestCertificate; | ||
| 3 | use Moose; | ||
| 4 | has CertificateAuthorityArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has DomainName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DomainValidationOptions => (is => 'ro', isa => 'ArrayRef[Paws::ACM::DomainValidationOption]'); | ||
| 7 | has IdempotencyToken => (is => 'ro', isa => 'Str'); | ||
| 8 | has Options => (is => 'ro', isa => 'Paws::ACM::CertificateOptions'); | ||
| 9 | has SubjectAlternativeNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ACM::Tag]'); | ||
| 11 | has ValidationMethod => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RequestCertificate'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ACM::RequestCertificateResponse'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::ACM::RequestCertificate - Arguments for method RequestCertificate on L<Paws::ACM> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method RequestCertificate on the | ||
| 29 | L<AWS Certificate Manager|Paws::ACM> service. Use the attributes of this class | ||
| 30 | as arguments to method RequestCertificate. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RequestCertificate. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $acm = Paws->service('ACM'); | ||
| 37 | my $RequestCertificateResponse = $acm->RequestCertificate( | ||
| 38 | DomainName => 'MyDomainNameString', | ||
| 39 | CertificateAuthorityArn => 'MyArn', # OPTIONAL | ||
| 40 | DomainValidationOptions => [ | ||
| 41 | { | ||
| 42 | DomainName => 'MyDomainNameString', # min: 1, max: 253 | ||
| 43 | ValidationDomain => 'MyDomainNameString', # min: 1, max: 253 | ||
| 44 | |||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # OPTIONAL | ||
| 48 | IdempotencyToken => 'MyIdempotencyToken', # OPTIONAL | ||
| 49 | Options => { | ||
| 50 | CertificateTransparencyLoggingPreference => | ||
| 51 | 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | SubjectAlternativeNames => [ | ||
| 54 | 'MyDomainNameString', ... # min: 1, max: 253 | ||
| 55 | ], # OPTIONAL | ||
| 56 | Tags => [ | ||
| 57 | { | ||
| 58 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 59 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 60 | }, | ||
| 61 | ... | ||
| 62 | ], # OPTIONAL | ||
| 63 | ValidationMethod => 'EMAIL', # OPTIONAL | ||
| 64 | ); | ||
| 65 | |||
| 66 | # Results: | ||
| 67 | my $CertificateArn = $RequestCertificateResponse->CertificateArn; | ||
| 68 | |||
| 69 | # Returns a L<Paws::ACM::RequestCertificateResponse> object. | ||
| 70 | |||
| 71 | 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. | ||
| 72 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/acm/RequestCertificate> | ||
| 73 | |||
| 74 | =head1 ATTRIBUTES | ||
| 75 | |||
| 76 | |||
| 77 | =head2 CertificateAuthorityArn => Str | ||
| 78 | |||
| 79 | The Amazon Resource Name (ARN) of the private certificate authority | ||
| 80 | (CA) that will be used to issue the certificate. If you do not provide | ||
| 81 | an ARN and you are trying to request a private certificate, ACM will | ||
| 82 | attempt to issue a public certificate. For more information about | ||
| 83 | private CAs, see the AWS Certificate Manager Private Certificate | ||
| 84 | Authority (PCA) | ||
| 85 | (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html) | ||
| 86 | user guide. The ARN must have the following form: | ||
| 87 | |||
| 88 | C<arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012> | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> DomainName => Str | ||
| 93 | |||
| 94 | Fully qualified domain name (FQDN), such as www.example.com, that you | ||
| 95 | want to secure with an ACM certificate. Use an asterisk (*) to create a | ||
| 96 | wildcard certificate that protects several sites in the same domain. | ||
| 97 | For example, *.example.com protects www.example.com, site.example.com, | ||
| 98 | and images.example.com. | ||
| 99 | |||
| 100 | The first domain name you enter cannot exceed 64 octets, including | ||
| 101 | periods. Each subsequent Subject Alternative Name (SAN), however, can | ||
| 102 | be up to 253 octets in length. | ||
| 103 | |||
| 104 | |||
| 105 | |||
| 106 | =head2 DomainValidationOptions => ArrayRef[L<Paws::ACM::DomainValidationOption>] | ||
| 107 | |||
| 108 | The domain name that you want ACM to use to send you emails so that you | ||
| 109 | can validate domain ownership. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 IdempotencyToken => Str | ||
| 114 | |||
| 115 | Customer chosen string that can be used to distinguish between calls to | ||
| 116 | C<RequestCertificate>. Idempotency tokens time out after one hour. | ||
| 117 | Therefore, if you call C<RequestCertificate> multiple times with the | ||
| 118 | same idempotency token within one hour, ACM recognizes that you are | ||
| 119 | requesting only one certificate and will issue only one. If you change | ||
| 120 | the idempotency token for each call, ACM recognizes that you are | ||
| 121 | requesting multiple certificates. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | =head2 Options => L<Paws::ACM::CertificateOptions> | ||
| 126 | |||
| 127 | Currently, you can use this parameter to specify whether to add the | ||
| 128 | certificate to a certificate transparency log. Certificate transparency | ||
| 129 | makes it possible to detect SSL/TLS certificates that have been | ||
| 130 | mistakenly or maliciously issued. Certificates that have not been | ||
| 131 | logged typically produce an error message in a browser. For more | ||
| 132 | information, see Opting Out of Certificate Transparency Logging | ||
| 133 | (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency). | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 SubjectAlternativeNames => ArrayRef[Str|Undef] | ||
| 138 | |||
| 139 | Additional FQDNs to be included in the Subject Alternative Name | ||
| 140 | extension of the ACM certificate. For example, add the name | ||
| 141 | www.example.net to a certificate for which the C<DomainName> field is | ||
| 142 | www.example.com if users can reach your site by using either name. The | ||
| 143 | maximum number of domain names that you can add to an ACM certificate | ||
| 144 | is 100. However, the initial quota is 10 domain names. If you need more | ||
| 145 | than 10 names, you must request a quota increase. For more information, | ||
| 146 | see Quotas | ||
| 147 | (https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html). | ||
| 148 | |||
| 149 | The maximum length of a SAN DNS name is 253 octets. The name is made up | ||
| 150 | of multiple labels separated by periods. No label can be longer than 63 | ||
| 151 | octets. Consider the following examples: | ||
| 152 | |||
| 153 | =over | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<(63 octets).(63 octets).(63 octets).(61 octets)> is legal because the | ||
| 158 | total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 | ||
| 159 | octets. | ||
| 160 | |||
| 161 | =item * | ||
| 162 | |||
| 163 | C<(64 octets).(63 octets).(63 octets).(61 octets)> is not legal because | ||
| 164 | the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first | ||
| 165 | label exceeds 63 octets. | ||
| 166 | |||
| 167 | =item * | ||
| 168 | |||
| 169 | C<(63 octets).(63 octets).(63 octets).(62 octets)> is not legal because | ||
| 170 | the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 | ||
| 171 | octets. | ||
| 172 | |||
| 173 | =back | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head2 Tags => ArrayRef[L<Paws::ACM::Tag>] | ||
| 179 | |||
| 180 | One or more resource tags to associate with the certificate. | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | =head2 ValidationMethod => Str | ||
| 185 | |||
| 186 | The method you want to use if you are requesting a public certificate | ||
| 187 | to validate that you own or control domain. You can validate with DNS | ||
| 188 | (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) | ||
| 189 | or validate with email | ||
| 190 | (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html). | ||
| 191 | We recommend that you use DNS validation. | ||
| 192 | |||
| 193 | Valid values are: C<"EMAIL">, C<"DNS"> | ||
| 194 | |||
| 195 | |||
| 196 | =head1 SEE ALSO | ||
| 197 | |||
| 198 | This class forms part of L<Paws>, documenting arguments for method RequestCertificate in L<Paws::ACM> | ||
| 199 | |||
| 200 | =head1 BUGS and CONTRIBUTIONS | ||
| 201 | |||
| 202 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 203 | |||
| 204 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 205 | |||
| 206 | =cut | ||
| 207 |