Class: Aws::Lightsail::Types::Certificate

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

Overview

Describes the full details of an Amazon Lightsail SSL/TLS certificate.

To get a summary of a certificate, use the GetCertificates action and ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the certificate.

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#created_atTime

The timestamp when the certificate was created.

Returns:

  • (Time)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

The domain name of the certificate.

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#domain_validation_recordsArray<Types::DomainValidationRecord>

An array of objects that describe the domain validation records of the certificate.

Returns:



1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#eligible_to_renewString

The renewal eligibility of the certificate.

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#in_use_resource_countInteger

The number of Lightsail resources that the certificate is attached to.

Returns:

  • (Integer)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#issued_atTime

The timestamp when the certificate was issued.

Returns:

  • (Time)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#issuer_caString

The certificate authority that issued the certificate.

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#key_algorithmString

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

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#not_afterTime

The timestamp when the certificate expires.

Returns:

  • (Time)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#not_beforeTime

The timestamp when the certificate is first valid.

Returns:

  • (Time)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#renewal_summaryTypes::RenewalSummary

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



1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#request_failure_reasonString

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.

    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.

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#revocation_reasonString

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

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#revoked_atTime

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

Returns:

  • (Time)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#serial_numberString

The serial number of the certificate.

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The validation status of the certificate.

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#subject_alternative_namesArray<String>

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

Returns:

  • (Array<String>)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#support_codeString

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

Returns:

  • (String)


1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1841

class Certificate < Struct.new(
  :arn,
  :name,
  :domain_name,
  :status,
  :serial_number,
  :subject_alternative_names,
  :domain_validation_records,
  :request_failure_reason,
  :in_use_resource_count,
  :key_algorithm,
  :created_at,
  :issued_at,
  :issuer_ca,
  :not_before,
  :not_after,
  :eligible_to_renew,
  :renewal_summary,
  :revoked_at,
  :revocation_reason,
  :tags,
  :support_code)
  SENSITIVE = []
  include Aws::Structure
end