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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

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)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#created_atTime

The time when you created your SSL/TLS certificate.

Returns:

  • (Time)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#domain_nameString

The domain name for your SSL/TLS certificate.

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#domain_validation_recordsArray<Types::LoadBalancerTlsCertificateDomainValidationRecord>

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#failure_reasonString

The reason for the SSL/TLS certificate validation failure.

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#is_attachedBoolean

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

Returns:

  • (Boolean)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#issued_atTime

The time when the SSL/TLS certificate was issued.

Returns:

  • (Time)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#issuerString

The issuer of the certificate.

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#key_algorithmString

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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#load_balancer_nameString

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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#locationTypes::ResourceLocation

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



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#not_afterTime

The timestamp when the SSL/TLS certificate expires.

Returns:

  • (Time)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#not_beforeTime

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

Returns:

  • (Time)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#renewal_summaryTypes::LoadBalancerTlsCertificateRenewalSummary

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



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#revocation_reasonString

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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#revoked_atTime

The timestamp when the SSL/TLS certificate was revoked.

Returns:

  • (Time)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#serialString

The serial number of the certificate.

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#signature_algorithmString

The algorithm that was used to sign the certificate.

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#subjectString

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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#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>)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end

#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)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3918

class LoadBalancerTlsCertificate < Struct.new(
  :name,
  :arn,
  :support_code,
  :created_at,
  :location,
  :resource_type,
  :load_balancer_name,
  :is_attached,
  :status,
  :domain_name,
  :domain_validation_records,
  :failure_reason,
  :issued_at,
  :issuer,
  :key_algorithm,
  :not_after,
  :not_before,
  :renewal_summary,
  :revocation_reason,
  :revoked_at,
  :serial,
  :signature_algorithm,
  :subject,
  :subject_alternative_names)
  include Aws::Structure
end