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

Inherits:

Struct

Object
Struct
Aws::Lightsail::Types::Certificate

show all

Includes:: Structure

Defined in:: lib/aws-sdk-lightsail/types.rb

Overview

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

<note markdown=“1”> To get a summary of a certificate, use the ‘GetCertificates` action and omit `includeCertificateDetails` from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

</note>

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String

The Amazon Resource Name (ARN) of the certificate.
#created_at ⇒ Time

The timestamp when the certificate was created.
#domain_name ⇒ String

The domain name of the certificate.
#domain_validation_records ⇒ Array<Types::DomainValidationRecord>

An array of objects that describe the domain validation records of the certificate.
#eligible_to_renew ⇒ String

The renewal eligibility of the certificate.
#in_use_resource_count ⇒ Integer

The number of Lightsail resources that the certificate is attached to.
#issued_at ⇒ Time

The timestamp when the certificate was issued.
#issuer_ca ⇒ String

The certificate authority that issued the certificate.
#key_algorithm ⇒ String

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

The name of the certificate (‘my-certificate`).
#not_after ⇒ Time

The timestamp when the certificate expires.
#not_before ⇒ Time

The timestamp when the certificate is first valid.
#renewal_summary ⇒ Types::RenewalSummary

An object that describes the status of the certificate renewal managed by Lightsail.
#request_failure_reason ⇒ String

The validation failure reason, if any, of the certificate.
#revocation_reason ⇒ String

The reason the certificate was revoked.
#revoked_at ⇒ Time

The timestamp when the certificate was revoked.
#serial_number ⇒ String

The serial number of the certificate.
#status ⇒ String

The validation status of the certificate.
#subject_alternative_names ⇒ Array<String>

An array of strings that specify the alternate domains (‘example2.com`) and subdomains (`blog.example.com`) of the certificate.
#support_code ⇒ String

The support code.
#tags ⇒ Array<Types::Tag>

The tag keys and optional values for the resource.

Instance Attribute Details

#arn ⇒ `String`

The Amazon Resource Name (ARN) of the certificate.

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_at ⇒ `Time`

The timestamp when the certificate was created.

Returns:

(Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_name ⇒ `String`

The domain name of the certificate.

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_records ⇒ `Array<Types::DomainValidationRecord>`

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

Returns:

(Array<Types::DomainValidationRecord>)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_renew ⇒ `String`

The renewal eligibility of the certificate.

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_count ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_at ⇒ `Time`

The timestamp when the certificate was issued.

Returns:

(Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_ca ⇒ `String`

The certificate authority that issued the certificate.

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_algorithm ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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

#name ⇒ `String`

The name of the certificate (‘my-certificate`).

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_after ⇒ `Time`

The timestamp when the certificate expires.

Returns:

(Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_before ⇒ `Time`

The timestamp when the certificate is first valid.

Returns:

(Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_summary ⇒ `Types::RenewalSummary`

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

Returns:

(Types::RenewalSummary)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_reason ⇒ `String`

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 [Amazon Web Services Support Center] to contact Amazon Web Services Support.

<note markdown=“1”> You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.
```
</note>
```
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 [Amazon Web Services 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.

[1]: console.aws.amazon.com/support/home [2]: www.virustotal.com/gui/home/url [3]: developers.google.com/web/fundamentals/security/hacked

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_reason ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_at ⇒ `Time`

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

Returns:

(Time)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_number ⇒ `String`

The serial number of the certificate.

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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

#status ⇒ `String`

The validation status of the certificate.

Returns:

(String)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_names ⇒ `Array<String>`

An array of strings that specify the alternate domains (‘example2.com`) and subdomains (`blog.example.com`) of the certificate.

Returns:

(Array<String>)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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_code ⇒ `String`

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)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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

#tags ⇒ `Array<Types::Tag>`

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

[1]: lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-tags

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-lightsail/types.rb', line 1776

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#created_at ⇒ Time

#domain_name ⇒ String

#domain_validation_records ⇒ Array<Types::DomainValidationRecord>

#eligible_to_renew ⇒ String

#in_use_resource_count ⇒ Integer

#issued_at ⇒ Time

#issuer_ca ⇒ String

#key_algorithm ⇒ String

#name ⇒ String

#not_after ⇒ Time

#not_before ⇒ Time

#renewal_summary ⇒ Types::RenewalSummary

#request_failure_reason ⇒ String

#revocation_reason ⇒ String

#revoked_at ⇒ Time

#serial_number ⇒ String

#status ⇒ String

#subject_alternative_names ⇒ Array<String>

#support_code ⇒ String

#tags ⇒ Array<Types::Tag>

#arn ⇒ `String`

#created_at ⇒ `Time`

#domain_name ⇒ `String`

#domain_validation_records ⇒ `Array<Types::DomainValidationRecord>`

#eligible_to_renew ⇒ `String`

#in_use_resource_count ⇒ `Integer`

#issued_at ⇒ `Time`

#issuer_ca ⇒ `String`

#key_algorithm ⇒ `String`

#name ⇒ `String`

#not_after ⇒ `Time`

#not_before ⇒ `Time`

#renewal_summary ⇒ `Types::RenewalSummary`

#request_failure_reason ⇒ `String`

#revocation_reason ⇒ `String`

#revoked_at ⇒ `Time`

#serial_number ⇒ `String`

#status ⇒ `String`

#subject_alternative_names ⇒ `Array<String>`

#support_code ⇒ `String`

#tags ⇒ `Array<Types::Tag>`