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

Returns:

  • (String)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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

Returns:

  • (Time)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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

Returns:

  • (String)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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.



3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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

Returns:

  • (String)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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 TLS/SSL certificate is attached to the Lightsail load balancer.

Returns:

  • (Boolean)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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

Returns:

  • (Time)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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 TLS/SSL certificate is attached.

Returns:

  • (String)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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.



3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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 TLS/SSL certificate (e.g., my-certificate).

Returns:

  • (String)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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

Returns:

  • (Time)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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 TLS/SSL certificate is first valid.

Returns:

  • (Time)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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.



3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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.

Returns:

  • (String)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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

Returns:

  • (Time)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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 TLS/SSL certificate. Valid values are below.

Returns:

  • (String)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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 domain names (subject alternative names) 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 (CN) of the certificate and additional domain names that can be used to connect to the website.

Returns:

  • (Array<String>)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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 TLS/SSL certificate. This code enables our support team to look up your Lightsail information more easily.

Returns:

  • (String)


3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3680

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