« blib/lib/Paws/Lightsail/LoadBalancerConfigurationOptions.pm
↑ Summary
blib/lib/Paws/Lightsail/LoadBalancerTlsCertificateDomainValidationOption.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Lightsail::LoadBalancerTlsCertificate; | ||
| 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::LoadBalancerTlsCertificateDomainValidationRecord]', request_name => 'domainValidationRecords', traits => ['NameInRequest']); | ||
| 8 | has FailureReason => (is => 'ro', isa => 'Str', request_name => 'failureReason', traits => ['NameInRequest']); | ||
| 9 | has IsAttached => (is => 'ro', isa => 'Bool', request_name => 'isAttached', traits => ['NameInRequest']); | ||
| 10 | has IssuedAt => (is => 'ro', isa => 'Str', request_name => 'issuedAt', traits => ['NameInRequest']); | ||
| 11 | has Issuer => (is => 'ro', isa => 'Str', request_name => 'issuer', traits => ['NameInRequest']); | ||
| 12 | has KeyAlgorithm => (is => 'ro', isa => 'Str', request_name => 'keyAlgorithm', traits => ['NameInRequest']); | ||
| 13 | has LoadBalancerName => (is => 'ro', isa => 'Str', request_name => 'loadBalancerName', traits => ['NameInRequest']); | ||
| 14 | has Location => (is => 'ro', isa => 'Paws::Lightsail::ResourceLocation', request_name => 'location', traits => ['NameInRequest']); | ||
| 15 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 16 | has NotAfter => (is => 'ro', isa => 'Str', request_name => 'notAfter', traits => ['NameInRequest']); | ||
| 17 | has NotBefore => (is => 'ro', isa => 'Str', request_name => 'notBefore', traits => ['NameInRequest']); | ||
| 18 | has RenewalSummary => (is => 'ro', isa => 'Paws::Lightsail::LoadBalancerTlsCertificateRenewalSummary', request_name => 'renewalSummary', traits => ['NameInRequest']); | ||
| 19 | has ResourceType => (is => 'ro', isa => 'Str', request_name => 'resourceType', traits => ['NameInRequest']); | ||
| 20 | has RevocationReason => (is => 'ro', isa => 'Str', request_name => 'revocationReason', traits => ['NameInRequest']); | ||
| 21 | has RevokedAt => (is => 'ro', isa => 'Str', request_name => 'revokedAt', traits => ['NameInRequest']); | ||
| 22 | has Serial => (is => 'ro', isa => 'Str', request_name => 'serial', traits => ['NameInRequest']); | ||
| 23 | has SignatureAlgorithm => (is => 'ro', isa => 'Str', request_name => 'signatureAlgorithm', traits => ['NameInRequest']); | ||
| 24 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 25 | has Subject => (is => 'ro', isa => 'Str', request_name => 'subject', traits => ['NameInRequest']); | ||
| 26 | has SubjectAlternativeNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'subjectAlternativeNames', traits => ['NameInRequest']); | ||
| 27 | has SupportCode => (is => 'ro', isa => 'Str', request_name => 'supportCode', traits => ['NameInRequest']); | ||
| 28 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Lightsail::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 29 | |||
| 30 | 1; | ||
| 31 | |||
| 32 | ### main pod documentation begin ### | ||
| 33 | |||
| 34 | =head1 NAME | ||
| 35 | |||
| 36 | Paws::Lightsail::LoadBalancerTlsCertificate | ||
| 37 | |||
| 38 | =head1 USAGE | ||
| 39 | |||
| 40 | This class represents one of two things: | ||
| 41 | |||
| 42 | =head3 Arguments in a call to a service | ||
| 43 | |||
| 44 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 45 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 46 | |||
| 47 | As an example, if Att1 is expected to be a Paws::Lightsail::LoadBalancerTlsCertificate object: | ||
| 48 | |||
| 49 | $service_obj->Method(Att1 => { Arn => $value, ..., Tags => $value }); | ||
| 50 | |||
| 51 | =head3 Results returned from an API call | ||
| 52 | |||
| 53 | Use accessors for each attribute. If Att1 is expected to be an Paws::Lightsail::LoadBalancerTlsCertificate object: | ||
| 54 | |||
| 55 | $result = $service_obj->Method(...); | ||
| 56 | $result->Att1->Arn | ||
| 57 | |||
| 58 | =head1 DESCRIPTION | ||
| 59 | |||
| 60 | Describes a load balancer SSL/TLS certificate. | ||
| 61 | |||
| 62 | TLS is just an updated, more secure version of Secure Socket Layer | ||
| 63 | (SSL). | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Arn => Str | ||
| 69 | |||
| 70 | The Amazon Resource Name (ARN) of the SSL/TLS certificate. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 CreatedAt => Str | ||
| 74 | |||
| 75 | The time when you created your SSL/TLS certificate. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 DomainName => Str | ||
| 79 | |||
| 80 | The domain name for your SSL/TLS certificate. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 DomainValidationRecords => ArrayRef[L<Paws::Lightsail::LoadBalancerTlsCertificateDomainValidationRecord>] | ||
| 84 | |||
| 85 | An array of LoadBalancerTlsCertificateDomainValidationRecord objects | ||
| 86 | describing the records. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 FailureReason => Str | ||
| 90 | |||
| 91 | The validation failure reason, if any, of the certificate. | ||
| 92 | |||
| 93 | The following failure reasons are possible: | ||
| 94 | |||
| 95 | =over | ||
| 96 | |||
| 97 | =item * | ||
| 98 | |||
| 99 | B<C<NO_AVAILABLE_CONTACTS> > - This failure applies to email | ||
| 100 | validation, which is not available for Lightsail certificates. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | B<C<ADDITIONAL_VERIFICATION_REQUIRED> > - Lightsail requires additional | ||
| 105 | information to process this certificate request. This can happen as a | ||
| 106 | fraud-protection measure, such as when the domain ranks within the | ||
| 107 | Alexa top 1000 websites. To provide the required information, use the | ||
| 108 | AWS Support Center (https://console.aws.amazon.com/support/home) to | ||
| 109 | contact AWS Support. | ||
| 110 | |||
| 111 | You cannot request a certificate for Amazon-owned domain names such as | ||
| 112 | those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com. | ||
| 113 | |||
| 114 | =item * | ||
| 115 | |||
| 116 | B<C<DOMAIN_NOT_ALLOWED> > - One or more of the domain names in the | ||
| 117 | certificate request was reported as an unsafe domain by VirusTotal | ||
| 118 | (https://www.virustotal.com/gui/home/url). To correct the problem, | ||
| 119 | search for your domain name on the VirusTotal | ||
| 120 | (https://www.virustotal.com/gui/home/url) website. If your domain is | ||
| 121 | reported as suspicious, see Google Help for Hacked Websites | ||
| 122 | (https://developers.google.com/web/fundamentals/security/hacked) to | ||
| 123 | learn what you can do. | ||
| 124 | |||
| 125 | If you believe that the result is a false positive, notify the | ||
| 126 | organization that is reporting the domain. VirusTotal is an aggregate | ||
| 127 | of several antivirus and URL scanners and cannot remove your domain | ||
| 128 | from a block list itself. After you correct the problem and the | ||
| 129 | VirusTotal registry has been updated, request a new certificate. | ||
| 130 | |||
| 131 | If you see this error and your domain is not included in the VirusTotal | ||
| 132 | list, visit the AWS Support Center | ||
| 133 | (https://console.aws.amazon.com/support/home) and create a case. | ||
| 134 | |||
| 135 | =item * | ||
| 136 | |||
| 137 | B<C<INVALID_PUBLIC_DOMAIN> > - One or more of the domain names in the | ||
| 138 | certificate request is not valid. Typically, this is because a domain | ||
| 139 | name in the request is not a valid top-level domain. Try to request a | ||
| 140 | certificate again, correcting any spelling errors or typos that were in | ||
| 141 | the failed request, and ensure that all domain names in the request are | ||
| 142 | for valid top-level domains. For example, you cannot request a | ||
| 143 | certificate for C<example.invalidpublicdomain> because | ||
| 144 | C<invalidpublicdomain> is not a valid top-level domain. | ||
| 145 | |||
| 146 | =item * | ||
| 147 | |||
| 148 | B<C<OTHER> > - Typically, this failure occurs when there is a | ||
| 149 | typographical error in one or more of the domain names in the | ||
| 150 | certificate request. Try to request a certificate again, correcting any | ||
| 151 | spelling errors or typos that were in the failed request. | ||
| 152 | |||
| 153 | =back | ||
| 154 | |||
| 155 | |||
| 156 | |||
| 157 | =head2 IsAttached => Bool | ||
| 158 | |||
| 159 | When C<true>, the SSL/TLS certificate is attached to the Lightsail load | ||
| 160 | balancer. | ||
| 161 | |||
| 162 | |||
| 163 | =head2 IssuedAt => Str | ||
| 164 | |||
| 165 | The time when the SSL/TLS certificate was issued. | ||
| 166 | |||
| 167 | |||
| 168 | =head2 Issuer => Str | ||
| 169 | |||
| 170 | The issuer of the certificate. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 KeyAlgorithm => Str | ||
| 174 | |||
| 175 | The algorithm used to generate the key pair (the public and private | ||
| 176 | key). | ||
| 177 | |||
| 178 | |||
| 179 | =head2 LoadBalancerName => Str | ||
| 180 | |||
| 181 | The load balancer name where your SSL/TLS certificate is attached. | ||
| 182 | |||
| 183 | |||
| 184 | =head2 Location => L<Paws::Lightsail::ResourceLocation> | ||
| 185 | |||
| 186 | The AWS Region and Availability Zone where you created your | ||
| 187 | certificate. | ||
| 188 | |||
| 189 | |||
| 190 | =head2 Name => Str | ||
| 191 | |||
| 192 | The name of the SSL/TLS certificate (e.g., C<my-certificate>). | ||
| 193 | |||
| 194 | |||
| 195 | =head2 NotAfter => Str | ||
| 196 | |||
| 197 | The timestamp when the SSL/TLS certificate expires. | ||
| 198 | |||
| 199 | |||
| 200 | =head2 NotBefore => Str | ||
| 201 | |||
| 202 | The timestamp when the SSL/TLS certificate is first valid. | ||
| 203 | |||
| 204 | |||
| 205 | =head2 RenewalSummary => L<Paws::Lightsail::LoadBalancerTlsCertificateRenewalSummary> | ||
| 206 | |||
| 207 | An object that describes the status of the certificate renewal managed | ||
| 208 | by Lightsail. | ||
| 209 | |||
| 210 | |||
| 211 | =head2 ResourceType => Str | ||
| 212 | |||
| 213 | The resource type (e.g., C<LoadBalancerTlsCertificate>). | ||
| 214 | |||
| 215 | =over | ||
| 216 | |||
| 217 | =item * | ||
| 218 | |||
| 219 | B<C<Instance> > - A Lightsail instance (a virtual private server) | ||
| 220 | |||
| 221 | =item * | ||
| 222 | |||
| 223 | B<C<StaticIp> > - A static IP address | ||
| 224 | |||
| 225 | =item * | ||
| 226 | |||
| 227 | B<C<KeyPair> > - The key pair used to connect to a Lightsail instance | ||
| 228 | |||
| 229 | =item * | ||
| 230 | |||
| 231 | B<C<InstanceSnapshot> > - A Lightsail instance snapshot | ||
| 232 | |||
| 233 | =item * | ||
| 234 | |||
| 235 | B<C<Domain> > - A DNS zone | ||
| 236 | |||
| 237 | =item * | ||
| 238 | |||
| 239 | B<C<PeeredVpc> > - A peered VPC | ||
| 240 | |||
| 241 | =item * | ||
| 242 | |||
| 243 | B<C<LoadBalancer> > - A Lightsail load balancer | ||
| 244 | |||
| 245 | =item * | ||
| 246 | |||
| 247 | B<C<LoadBalancerTlsCertificate> > - An SSL/TLS certificate associated | ||
| 248 | with a Lightsail load balancer | ||
| 249 | |||
| 250 | =item * | ||
| 251 | |||
| 252 | B<C<Disk> > - A Lightsail block storage disk | ||
| 253 | |||
| 254 | =item * | ||
| 255 | |||
| 256 | B<C<DiskSnapshot> > - A block storage disk snapshot | ||
| 257 | |||
| 258 | =back | ||
| 259 | |||
| 260 | |||
| 261 | |||
| 262 | =head2 RevocationReason => Str | ||
| 263 | |||
| 264 | The reason the certificate was revoked. This value is present only when | ||
| 265 | the certificate status is C<REVOKED>. | ||
| 266 | |||
| 267 | |||
| 268 | =head2 RevokedAt => Str | ||
| 269 | |||
| 270 | The timestamp when the certificate was revoked. This value is present | ||
| 271 | only when the certificate status is C<REVOKED>. | ||
| 272 | |||
| 273 | |||
| 274 | =head2 Serial => Str | ||
| 275 | |||
| 276 | The serial number of the certificate. | ||
| 277 | |||
| 278 | |||
| 279 | =head2 SignatureAlgorithm => Str | ||
| 280 | |||
| 281 | The algorithm that was used to sign the certificate. | ||
| 282 | |||
| 283 | |||
| 284 | =head2 Status => Str | ||
| 285 | |||
| 286 | The validation status of the SSL/TLS certificate. Valid values are | ||
| 287 | below. | ||
| 288 | |||
| 289 | |||
| 290 | =head2 Subject => Str | ||
| 291 | |||
| 292 | The name of the entity that is associated with the public key contained | ||
| 293 | in the certificate. | ||
| 294 | |||
| 295 | |||
| 296 | =head2 SubjectAlternativeNames => ArrayRef[Str|Undef] | ||
| 297 | |||
| 298 | An array of strings that specify the alternate domains (e.g., | ||
| 299 | C<example2.com>) and subdomains (e.g., C<blog.example.com>) for the | ||
| 300 | certificate. | ||
| 301 | |||
| 302 | |||
| 303 | =head2 SupportCode => Str | ||
| 304 | |||
| 305 | The support code. Include this code in your email to support when you | ||
| 306 | have questions about your Lightsail load balancer or SSL/TLS | ||
| 307 | certificate. This code enables our support team to look up your | ||
| 308 | Lightsail information more easily. | ||
| 309 | |||
| 310 | |||
| 311 | =head2 Tags => ArrayRef[L<Paws::Lightsail::Tag>] | ||
| 312 | |||
| 313 | The tag keys and optional values for the resource. For more information | ||
| 314 | about tags in Lightsail, see the Lightsail Dev Guide | ||
| 315 | (https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-tags). | ||
| 316 | |||
| 317 | |||
| 318 | |||
| 319 | =head1 SEE ALSO | ||
| 320 | |||
| 321 | This class forms part of L<Paws>, describing an object used in L<Paws::Lightsail> | ||
| 322 | |||
| 323 | =head1 BUGS and CONTRIBUTIONS | ||
| 324 | |||
| 325 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 326 | |||
| 327 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 328 | |||
| 329 | =cut | ||
| 330 |