Menu
Amazon Lightsail
REST API Reference (API Version 2016-11-28)

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 reason for the SSL/TLS certificate validation failure.

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 that was 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 containing information about the status of Lightsail's managed renewal for the certificate.

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

Required: No

revocationReason

The reason the certificate was revoked. Valid values are below.

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 SSL/TLS certificate was 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 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

One or more domains or subdomains included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com, www.example.com, or m.example.com.

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

See Also

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

On this page: