blib/lib/Paws/Lightsail/Certificate.pm untested

filter: Statementstmt 0.0% 0 / 45 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 46 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Lightsail::Certificate;
3 use Moose;
4 has Arn => (is => 'ro', isa => 'Str', request_name => 'arn', traits => ['NameInRequest']);
5 has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']);
6 has DomainName => (is => 'ro', isa => 'Str', request_name => 'domainName', traits => ['NameInRequest']);
7 has DomainValidationRecords => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::DomainValidationRecord]', request_name => 'domainValidationRecords', traits => ['NameInRequest']);
8 has EligibleToRenew => (is => 'ro', isa => 'Str', request_name => 'eligibleToRenew', traits => ['NameInRequest']);
9 has InUseResourceCount => (is => 'ro', isa => 'Int', request_name => 'inUseResourceCount', traits => ['NameInRequest']);
10 has IssuedAt => (is => 'ro', isa => 'Str', request_name => 'issuedAt', traits => ['NameInRequest']);
11 has IssuerCA => (is => 'ro', isa => 'Str', request_name => 'issuerCA', traits => ['NameInRequest']);
12 has KeyAlgorithm => (is => 'ro', isa => 'Str', request_name => 'keyAlgorithm', traits => ['NameInRequest']);
13 has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']);
14 has NotAfter => (is => 'ro', isa => 'Str', request_name => 'notAfter', traits => ['NameInRequest']);
15 has NotBefore => (is => 'ro', isa => 'Str', request_name => 'notBefore', traits => ['NameInRequest']);
16 has RenewalSummary => (is => 'ro', isa => 'Paws::Lightsail::RenewalSummary', request_name => 'renewalSummary', traits => ['NameInRequest']);
17 has RequestFailureReason => (is => 'ro', isa => 'Str', request_name => 'requestFailureReason', traits => ['NameInRequest']);
18 has RevocationReason => (is => 'ro', isa => 'Str', request_name => 'revocationReason', traits => ['NameInRequest']);
19 has RevokedAt => (is => 'ro', isa => 'Str', request_name => 'revokedAt', traits => ['NameInRequest']);
20 has SerialNumber => (is => 'ro', isa => 'Str', request_name => 'serialNumber', traits => ['NameInRequest']);
21 has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']);
22 has SubjectAlternativeNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'subjectAlternativeNames', traits => ['NameInRequest']);
23 has SupportCode => (is => 'ro', isa => 'Str', request_name => 'supportCode', traits => ['NameInRequest']);
24 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', request_name => 'tags', traits => ['NameInRequest']);
25  
26 1;
27  
28 ### main pod documentation begin ###
29  
30 =head1 NAME
31  
32 Paws::Lightsail::Certificate
33  
34 =head1 USAGE
35  
36 This class represents one of two things:
37  
38 =head3 Arguments in a call to a service
39  
40 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
41 Each attribute should be used as a named argument in the calls that expect this type of object.
42  
43 As an example, if Att1 is expected to be a Paws::Lightsail::Certificate object:
44  
45 $service_obj->Method(Att1 => { Arn => $value, ..., Tags => $value });
46  
47 =head3 Results returned from an API call
48  
49 Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::Certificate object:
50  
51 $result = $service_obj->Method(...);
52 $result->Att1->Arn
53  
54 =head1 DESCRIPTION
55  
56 Describes the full details of an Amazon Lightsail SSL/TLS certificate.
57  
58 To get a summary of a certificate, use the C<GetCertificates> action
59 and ommit C<includeCertificateDetails> from your request. The response
60 will include only the certificate Amazon Resource Name (ARN),
61 certificate name, domain name, and tags.
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 Arn => Str
67  
68 The Amazon Resource Name (ARN) of the certificate.
69  
70  
71 =head2 CreatedAt => Str
72  
73 The timestamp when the certificate was created.
74  
75  
76 =head2 DomainName => Str
77  
78 The domain name of the certificate.
79  
80  
81 =head2 DomainValidationRecords => ArrayRef[L<Paws::Lightsail::DomainValidationRecord>]
82  
83 An array of objects that describe the domain validation records of the
84 certificate.
85  
86  
87 =head2 EligibleToRenew => Str
88  
89 The renewal eligibility of the certificate.
90  
91  
92 =head2 InUseResourceCount => Int
93  
94 The number of Lightsail resources that the certificate is attached to.
95  
96  
97 =head2 IssuedAt => Str
98  
99 The timestamp when the certificate was issued.
100  
101  
102 =head2 IssuerCA => Str
103  
104 The certificate authority that issued the certificate.
105  
106  
107 =head2 KeyAlgorithm => Str
108  
109 The algorithm used to generate the key pair (the public and private
110 key) of the certificate.
111  
112  
113 =head2 Name => Str
114  
115 The name of the certificate (e.g., C<my-certificate>).
116  
117  
118 =head2 NotAfter => Str
119  
120 The timestamp when the certificate expires.
121  
122  
123 =head2 NotBefore => Str
124  
125 The timestamp when the certificate is first valid.
126  
127  
128 =head2 RenewalSummary => L<Paws::Lightsail::RenewalSummary>
129  
130 An object that describes the status of the certificate renewal managed
131 by Lightsail.
132  
133  
134 =head2 RequestFailureReason => Str
135  
136 The validation failure reason, if any, of the certificate.
137  
138 The following failure reasons are possible:
139  
140 =over
141  
142 =item *
143  
144 B<C<NO_AVAILABLE_CONTACTS> > - This failure applies to email
145 validation, which is not available for Lightsail certificates.
146  
147 =item *
148  
149 B<C<ADDITIONAL_VERIFICATION_REQUIRED> > - Lightsail requires additional
150 information to process this certificate request. This can happen as a
151 fraud-protection measure, such as when the domain ranks within the
152 Alexa top 1000 websites. To provide the required information, use the
153 AWS Support Center (https://console.aws.amazon.com/support/home) to
154 contact AWS Support.
155  
156 You cannot request a certificate for Amazon-owned domain names such as
157 those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
158  
159 =item *
160  
161 B<C<DOMAIN_NOT_ALLOWED> > - One or more of the domain names in the
162 certificate request was reported as an unsafe domain by VirusTotal
163 (https://www.virustotal.com/gui/home/url). To correct the problem,
164 search for your domain name on the VirusTotal
165 (https://www.virustotal.com/gui/home/url) website. If your domain is
166 reported as suspicious, see Google Help for Hacked Websites
167 (https://developers.google.com/web/fundamentals/security/hacked) to
168 learn what you can do.
169  
170 If you believe that the result is a false positive, notify the
171 organization that is reporting the domain. VirusTotal is an aggregate
172 of several antivirus and URL scanners and cannot remove your domain
173 from a block list itself. After you correct the problem and the
174 VirusTotal registry has been updated, request a new certificate.
175  
176 If you see this error and your domain is not included in the VirusTotal
177 list, visit the AWS Support Center
178 (https://console.aws.amazon.com/support/home) and create a case.
179  
180 =item *
181  
182 B<C<INVALID_PUBLIC_DOMAIN> > - One or more of the domain names in the
183 certificate request is not valid. Typically, this is because a domain
184 name in the request is not a valid top-level domain. Try to request a
185 certificate again, correcting any spelling errors or typos that were in
186 the failed request, and ensure that all domain names in the request are
187 for valid top-level domains. For example, you cannot request a
188 certificate for C<example.invalidpublicdomain> because
189 C<invalidpublicdomain> is not a valid top-level domain.
190  
191 =item *
192  
193 B<C<OTHER> > - Typically, this failure occurs when there is a
194 typographical error in one or more of the domain names in the
195 certificate request. Try to request a certificate again, correcting any
196 spelling errors or typos that were in the failed request.
197  
198 =back
199  
200  
201  
202 =head2 RevocationReason => Str
203  
204 The reason the certificate was revoked. This value is present only when
205 the certificate status is C<REVOKED>.
206  
207  
208 =head2 RevokedAt => Str
209  
210 The timestamp when the certificate was revoked. This value is present
211 only when the certificate status is C<REVOKED>.
212  
213  
214 =head2 SerialNumber => Str
215  
216 The serial number of the certificate.
217  
218  
219 =head2 Status => Str
220  
221 The validation status of the certificate.
222  
223  
224 =head2 SubjectAlternativeNames => ArrayRef[Str|Undef]
225  
226 An array of strings that specify the alternate domains (e.g.,
227 C<example2.com>) and subdomains (e.g., C<blog.example.com>) of the
228 certificate.
229  
230  
231 =head2 SupportCode => Str
232  
233 The support code. Include this code in your email to support when you
234 have questions about your Lightsail certificate. This code enables our
235 support team to look up your Lightsail information more easily.
236  
237  
238 =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>]
239  
240 The tag keys and optional values for the resource. For more information
241 about tags in Lightsail, see the Lightsail Dev Guide
242 (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags).
243  
244  
245  
246 =head1 SEE ALSO
247  
248 This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail>
249  
250 =head1 BUGS and CONTRIBUTIONS
251  
252 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
253  
254 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
255  
256 =cut
257