You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::ACM::Types::CertificateDetail
- Inherits:
-
Struct
- Object
- Struct
- Aws::ACM::Types::CertificateDetail
- Defined in:
- (unknown)
Overview
Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.
Returned by:
Instance Attribute Summary collapse
-
#certificate_arn ⇒ String
The Amazon Resource Name (ARN) of the certificate.
-
#certificate_authority_arn ⇒ String
The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate.
-
#created_at ⇒ Time
The time at which the certificate was requested.
-
#domain_name ⇒ String
The fully qualified domain name for the certificate, such as www.example.com or example.com.
-
#domain_validation_options ⇒ Array<Types::DomainValidation>
Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.
-
#extended_key_usages ⇒ Array<Types::ExtendedKeyUsage>
Contains a list of Extended Key Usage X.509 v3 extension objects.
-
#failure_reason ⇒ String
The reason the certificate request failed.
-
#imported_at ⇒ Time
The date and time at which the certificate was imported.
-
#in_use_by ⇒ Array<String>
A list of ARNs for the AWS resources that are using the certificate.
-
#issued_at ⇒ Time
The time at which the certificate was issued.
-
#issuer ⇒ String
The name of the certificate authority that issued and signed the certificate.
-
#key_algorithm ⇒ String
The algorithm that was used to generate the public-private key pair.
-
#key_usages ⇒ Array<Types::KeyUsage>
A list of Key Usage X.509 v3 extension objects.
-
#not_after ⇒ Time
The time after which the certificate is not valid.
-
#not_before ⇒ Time
The time before which the certificate is not valid.
-
#options ⇒ Types::CertificateOptions
Value that specifies whether to add the certificate to a transparency log.
-
#renewal_eligibility ⇒ String
Specifies whether the certificate is eligible for renewal.
-
#renewal_summary ⇒ Types::RenewalSummary
Contains information about the status of ACM\'s [managed renewal][1] for the certificate.
-
#revocation_reason ⇒ String
The reason the certificate was revoked.
-
#revoked_at ⇒ Time
The time at which the certificate was revoked.
-
#serial ⇒ String
The serial number of the certificate.
-
#signature_algorithm ⇒ String
The algorithm that was used to sign the certificate.
-
#status ⇒ String
The status of the certificate.
-
#subject ⇒ String
The name of the entity that is associated with the public key contained in the certificate.
-
#subject_alternative_names ⇒ Array<String>
One or more domain names (subject alternative names) included in the certificate.
-
#type ⇒ String
The source of the certificate.
Instance Attribute Details
#certificate_arn ⇒ String
The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.
#certificate_authority_arn ⇒ String
The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
#created_at ⇒ Time
The time at which the certificate was requested. This value exists only
when the certificate type is AMAZON_ISSUED
.
#domain_name ⇒ String
The fully qualified domain name for the certificate, such as www.example.com or example.com.
#domain_validation_options ⇒ Array<Types::DomainValidation>
Contains information about the initial validation of each domain name
that occurs as a result of the RequestCertificate request. This
field exists only when the certificate type is AMAZON_ISSUED
.
#extended_key_usages ⇒ Array<Types::ExtendedKeyUsage>
Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
#failure_reason ⇒ String
The reason the certificate request failed. This value exists only when
the certificate status is FAILED
. For more information, see
Certificate Request Failed in the AWS Certificate Manager User
Guide.
#imported_at ⇒ Time
The date and time at which the certificate was imported. This value
exists only when the certificate type is IMPORTED
.
#in_use_by ⇒ Array<String>
A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.
#issued_at ⇒ Time
The time at which the certificate was issued. This value exists only
when the certificate type is AMAZON_ISSUED
.
#issuer ⇒ String
The name of the certificate authority that issued and signed the certificate.
#key_algorithm ⇒ String
The algorithm that was used to generate the public-private key pair.
Possible values:
- RSA_2048
- RSA_1024
- RSA_4096
- EC_prime256v1
- EC_secp384r1
- EC_secp521r1
#key_usages ⇒ Array<Types::KeyUsage>
A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
#not_after ⇒ Time
The time after which the certificate is not valid.
#not_before ⇒ Time
The time before which the certificate is not valid.
#options ⇒ Types::CertificateOptions
Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure.
#renewal_eligibility ⇒ String
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
Possible values:
- ELIGIBLE
- INELIGIBLE
#renewal_summary ⇒ Types::RenewalSummary
Contains information about the status of ACM\'s managed renewal for
the certificate. This field exists only when the certificate type is
AMAZON_ISSUED
.
#revocation_reason ⇒ String
The reason the certificate was revoked. This value exists only when the
certificate status is REVOKED
.
Possible values:
- UNSPECIFIED
- KEY_COMPROMISE
- CA_COMPROMISE
- AFFILIATION_CHANGED
- SUPERCEDED
- CESSATION_OF_OPERATION
- CERTIFICATE_HOLD
- REMOVE_FROM_CRL
- PRIVILEGE_WITHDRAWN
- A_A_COMPROMISE
#revoked_at ⇒ Time
The time at which the certificate was revoked. This value exists only
when the certificate status is REVOKED
.
#serial ⇒ String
The serial number of the certificate.
#signature_algorithm ⇒ String
The algorithm that was used to sign the certificate.
#status ⇒ String
The status of the certificate.
Possible values:
- PENDING_VALIDATION
- ISSUED
- INACTIVE
- EXPIRED
- VALIDATION_TIMED_OUT
- REVOKED
- FAILED
#subject ⇒ String
The name of the entity that is associated with the public key contained in the certificate.
#subject_alternative_names ⇒ Array<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.
#type ⇒ String
The source of the certificate. For certificates provided by ACM, this
value is AMAZON_ISSUED
. For certificates that you imported with
ImportCertificate, this value is IMPORTED
. ACM does not provide
managed renewal for imported certificates. For more information
about the differences between certificates that you import and those
that ACM provides, see Importing Certificates in the AWS
Certificate Manager User Guide.