LoadBalancerTlsCertificate - Amazon Lightsail

LoadBalancerTlsCertificate

Describes a load balancer SSL/TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Contents

arn

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

Type: String

Pattern: .*\S.*

Required: No

createdAt

The time when you created your SSL/TLS certificate.

Type: Timestamp

Required: No

domainName

The domain name for your SSL/TLS certificate.

Type: String

Required: No

domainValidationRecords

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

Type: Array of LoadBalancerTlsCertificateDomainValidationRecord objects

Required: No

failureReason

The validation failure reason, if any, of the certificate.

The following failure reasons are possible:

  • NO_AVAILABLE_CONTACTS - This failure applies to email validation, which is not available for Lightsail certificates.

  • ADDITIONAL_VERIFICATION_REQUIRED - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the AWS Support Center to contact AWS Support.

    Note

    You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.

  • DOMAIN_NOT_ALLOWED - One or more of the domain names in the certificate request was reported as an unsafe domain by VirusTotal. To correct the problem, search for your domain name on the VirusTotal website. If your domain is reported as suspicious, see Google Help for Hacked Websites to learn what you can do.

    If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.

    If you see this error and your domain is not included in the VirusTotal list, visit the AWS Support Center and create a case.

  • INVALID_PUBLIC_DOMAIN - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for example.invalidpublicdomain because invalidpublicdomain is not a valid top-level domain.

  • OTHER - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request.

Type: String

Valid Values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | OTHER

Required: No

isAttached

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

Type: Boolean

Required: No

issuedAt

The time when the SSL/TLS certificate was issued.

Type: Timestamp

Required: No

issuer

The issuer of the certificate.

Type: String

Pattern: .*\S.*

Required: No

keyAlgorithm

The algorithm used to generate the key pair (the public and private key).

Type: String

Pattern: .*\S.*

Required: No

loadBalancerName

The load balancer name where your SSL/TLS certificate is attached.

Type: String

Pattern: \w[\w\-]*\w

Required: No

location

The AWS Region and Availability Zone where you created your certificate.

Type: ResourceLocation object

Required: No

name

The name of the SSL/TLS certificate (e.g., my-certificate).

Type: String

Pattern: \w[\w\-]*\w

Required: No

notAfter

The timestamp when the SSL/TLS certificate expires.

Type: Timestamp

Required: No

notBefore

The timestamp when the SSL/TLS certificate is first valid.

Type: Timestamp

Required: No

renewalSummary

An object that describes the status of the certificate renewal managed by Lightsail.

Type: LoadBalancerTlsCertificateRenewalSummary object

Required: No

resourceType

The resource type (e.g., LoadBalancerTlsCertificate).

  • Instance - A Lightsail instance (a virtual private server)

  • StaticIp - A static IP address

  • KeyPair - The key pair used to connect to a Lightsail instance

  • InstanceSnapshot - A Lightsail instance snapshot

  • Domain - A DNS zone

  • PeeredVpc - A peered VPC

  • LoadBalancer - A Lightsail load balancer

  • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer

  • Disk - A Lightsail block storage disk

  • DiskSnapshot - A block storage disk snapshot

Type: String

Valid Values: Instance | StaticIp | KeyPair | InstanceSnapshot | Domain | PeeredVpc | LoadBalancer | LoadBalancerTlsCertificate | Disk | DiskSnapshot | RelationalDatabase | RelationalDatabaseSnapshot | ExportSnapshotRecord | CloudFormationStackRecord | Alarm | ContactMethod | Distribution | Certificate

Required: No

revocationReason

The reason the certificate was revoked. This value is present only when the certificate status is REVOKED.

Type: String

Valid Values: UNSPECIFIED | KEY_COMPROMISE | CA_COMPROMISE | AFFILIATION_CHANGED | SUPERCEDED | CESSATION_OF_OPERATION | CERTIFICATE_HOLD | REMOVE_FROM_CRL | PRIVILEGE_WITHDRAWN | A_A_COMPROMISE

Required: No

revokedAt

The timestamp when the certificate was revoked. This value is present only when the certificate status is REVOKED.

Type: Timestamp

Required: No

serial

The serial number of the certificate.

Type: String

Pattern: .*\S.*

Required: No

signatureAlgorithm

The algorithm that was used to sign the certificate.

Type: String

Pattern: .*\S.*

Required: No

status

The validation status of the SSL/TLS certificate. Valid values are below.

Type: String

Valid Values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED | UNKNOWN

Required: No

subject

The name of the entity that is associated with the public key contained in the certificate.

Type: String

Pattern: .*\S.*

Required: No

subjectAlternativeNames

An array of strings that specify the alternate domains (e.g., example2.com) and subdomains (e.g., blog.example.com) for the certificate.

Type: Array of strings

Required: No

supportCode

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.

Type: String

Required: No

tags

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

Type: Array of Tag objects

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: