You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Lightsail::Types::LoadBalancerTlsCertificate

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes a load balancer SSL/TLS certificate.

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

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)

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

#created_atTime

The time when you created your SSL/TLS certificate.

Returns:

  • (Time)

    The time when you created your SSL/TLS certificate.

#domain_nameString

The domain name for your SSL/TLS certificate.

Returns:

  • (String)

    The domain name for your SSL/TLS certificate.

#domain_validation_recordsArray<Types::LoadBalancerTlsCertificateDomainValidationRecord>

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

Returns:

#failure_reasonString

The reason for the SSL/TLS certificate validation failure.

Possible values:

  • NO_AVAILABLE_CONTACTS
  • ADDITIONAL_VERIFICATION_REQUIRED
  • DOMAIN_NOT_ALLOWED
  • INVALID_PUBLIC_DOMAIN
  • OTHER

Returns:

  • (String)

    The reason for the SSL/TLS certificate validation failure.

#is_attachedBoolean

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

Returns:

  • (Boolean)

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

#issued_atTime

The time when the SSL/TLS certificate was issued.

Returns:

  • (Time)

    The time when the SSL/TLS certificate was issued.

#issuerString

The issuer of the certificate.

Returns:

  • (String)

    The issuer of the certificate.

#key_algorithmString

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

Returns:

  • (String)

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

#load_balancer_nameString

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

Returns:

  • (String)

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

#locationTypes::ResourceLocation

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

Returns:

#nameString

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

Returns:

  • (String)

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

#not_afterTime

The timestamp when the SSL/TLS certificate expires.

Returns:

  • (Time)

    The timestamp when the SSL/TLS certificate expires.

#not_beforeTime

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

Returns:

  • (Time)

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

#renewal_summaryTypes::LoadBalancerTlsCertificateRenewalSummary

An object containing information about the status of Lightsail\'s managed renewal for the certificate.

Returns:

#resource_typeString

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

    Possible values:

    • Instance
    • StaticIp
    • KeyPair
    • InstanceSnapshot
    • Domain
    • PeeredVpc
    • LoadBalancer
    • LoadBalancerTlsCertificate
    • Disk
    • DiskSnapshot

Returns:

  • (String)

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

#revocation_reasonString

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

Possible values:

  • UNSPECIFIED
  • KEY_COMPROMISE
  • CA_COMPROMISE
  • AFFILIATION_CHANGED
  • SUPERCEDED
  • CESSATION_OF_OPERATION
  • CERTIFICATE_HOLD
  • REMOVE_FROM_CRL
  • PRIVILEGE_WITHDRAWN
  • A_A_COMPROMISE

Returns:

  • (String)

    The reason the certificate was revoked.

#revoked_atTime

The timestamp when the SSL/TLS certificate was revoked.

Returns:

  • (Time)

    The timestamp when the SSL/TLS certificate was revoked.

#serialString

The serial number of the certificate.

Returns:

  • (String)

    The serial number of the certificate.

#signature_algorithmString

The algorithm that was used to sign the certificate.

Returns:

  • (String)

    The algorithm that was used to sign the certificate.

#statusString

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

Possible values:

  • PENDING_VALIDATION
  • ISSUED
  • INACTIVE
  • EXPIRED
  • VALIDATION_TIMED_OUT
  • REVOKED
  • FAILED
  • UNKNOWN

Returns:

  • (String)

    The status of the SSL/TLS certificate.

#subjectString

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

Returns:

  • (String)

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

#subject_alternative_namesArray<String>

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.

Returns:

  • (Array<String>)

    One or more domains or subdomains included in the certificate.

#support_codeString

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.

Returns:

  • (String)

    The support code.