File Coverage

blib/lib/Paws/ACM/RequestCertificate.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ACM::RequestCertificate;
3 1     1   318 use Moose;
  1         2  
  1         7  
4             has DomainName => (is => 'ro', isa => 'Str', required => 1);
5             has DomainValidationOptions => (is => 'ro', isa => 'ArrayRef[Paws::ACM::DomainValidationOption]');
6             has IdempotencyToken => (is => 'ro', isa => 'Str');
7             has SubjectAlternativeNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8              
9 1     1   5347 use MooseX::ClassAttribute;
  1         2  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'RequestCertificate');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ACM::RequestCertificateResponse');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::ACM::RequestCertificate - Arguments for method RequestCertificate on Paws::ACM
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method RequestCertificate on the
25             AWS Certificate Manager service. Use the attributes of this class
26             as arguments to method RequestCertificate.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RequestCertificate.
29              
30             As an example:
31              
32             $service_obj->RequestCertificate(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> DomainName => Str
40              
41             Fully qualified domain name (FQDN), such as www.example.com, of the
42             site that you want to secure with an ACM Certificate. Use an asterisk
43             (*) to create a wildcard certificate that protects several sites in the
44             same domain. For example, *.example.com protects www.example.com,
45             site.example.com, and images.example.com.
46              
47             The maximum length of a DNS name is 253 octets. The name is made up of
48             multiple labels separated by periods. No label can be longer than 63
49             octets. Consider the following examples:
50              
51             C<(63 octets).(63 octets).(63 octets).(61 octets)> is legal because the
52             total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63
53             octets.
54              
55             C<(64 octets).(63 octets).(63 octets).(61 octets)> is not legal because
56             the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first
57             label exceeds 63 octets.
58              
59             C<(63 octets).(63 octets).(63 octets).(62 octets)> is not legal because
60             the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253
61             octets.
62              
63              
64              
65             =head2 DomainValidationOptions => ArrayRef[L<Paws::ACM::DomainValidationOption>]
66              
67             The domain name that you want ACM to use to send you emails to validate
68             your ownership of the domain.
69              
70              
71              
72             =head2 IdempotencyToken => Str
73              
74             Customer chosen string that can be used to distinguish between calls to
75             C<RequestCertificate>. Idempotency tokens time out after one hour.
76             Therefore, if you call C<RequestCertificate> multiple times with the
77             same idempotency token within one hour, ACM recognizes that you are
78             requesting only one certificate and will issue only one. If you change
79             the idempotency token for each call, ACM recognizes that you are
80             requesting multiple certificates.
81              
82              
83              
84             =head2 SubjectAlternativeNames => ArrayRef[Str|Undef]
85              
86             Additional FQDNs to be included in the Subject Alternative Name
87             extension of the ACM Certificate. For example, add the name
88             www.example.net to a certificate for which the C<DomainName> field is
89             www.example.com if users can reach your site by using either name. The
90             maximum number of domain names that you can add to an ACM Certificate
91             is 100. However, the initial limit is 10 domain names. If you need more
92             than 10 names, you must request a limit increase. For more information,
93             see Limits.
94              
95              
96              
97              
98             =head1 SEE ALSO
99              
100             This class forms part of L<Paws>, documenting arguments for method RequestCertificate in L<Paws::ACM>
101              
102             =head1 BUGS and CONTRIBUTIONS
103              
104             The source code is located here: https://github.com/pplu/aws-sdk-perl
105              
106             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
107              
108             =cut
109