Struct aws_sdk_acm::types::CertificateDetail
source · #[non_exhaustive]pub struct CertificateDetail {Show 26 fields
pub certificate_arn: Option<String>,
pub domain_name: Option<String>,
pub subject_alternative_names: Option<Vec<String>>,
pub domain_validation_options: Option<Vec<DomainValidation>>,
pub serial: Option<String>,
pub subject: Option<String>,
pub issuer: Option<String>,
pub created_at: Option<DateTime>,
pub issued_at: Option<DateTime>,
pub imported_at: Option<DateTime>,
pub status: Option<CertificateStatus>,
pub revoked_at: Option<DateTime>,
pub revocation_reason: Option<RevocationReason>,
pub not_before: Option<DateTime>,
pub not_after: Option<DateTime>,
pub key_algorithm: Option<KeyAlgorithm>,
pub signature_algorithm: Option<String>,
pub in_use_by: Option<Vec<String>>,
pub failure_reason: Option<FailureReason>,
pub type: Option<CertificateType>,
pub renewal_summary: Option<RenewalSummary>,
pub key_usages: Option<Vec<KeyUsage>>,
pub extended_key_usages: Option<Vec<ExtendedKeyUsage>>,
pub certificate_authority_arn: Option<String>,
pub renewal_eligibility: Option<RenewalEligibility>,
pub options: Option<CertificateOptions>,
}
Expand description
Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate
request.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.certificate_arn: Option<String>
The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
domain_name: Option<String>
The fully qualified domain name for the certificate, such as www.example.com or example.com.
subject_alternative_names: Option<Vec<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.
domain_validation_options: Option<Vec<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
.
serial: Option<String>
The serial number of the certificate.
subject: Option<String>
The name of the entity that is associated with the public key contained in the certificate.
issuer: Option<String>
The name of the certificate authority that issued and signed the certificate.
created_at: Option<DateTime>
The time at which the certificate was requested.
issued_at: Option<DateTime>
The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED
.
imported_at: Option<DateTime>
The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED
.
status: Option<CertificateStatus>
The status of the certificate.
A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
revoked_at: Option<DateTime>
The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED
.
revocation_reason: Option<RevocationReason>
The reason the certificate was revoked. This value exists only when the certificate status is REVOKED
.
not_before: Option<DateTime>
The time before which the certificate is not valid.
not_after: Option<DateTime>
The time after which the certificate is not valid.
key_algorithm: Option<KeyAlgorithm>
The algorithm that was used to generate the public-private key pair.
signature_algorithm: Option<String>
The algorithm that was used to sign the certificate.
in_use_by: Option<Vec<String>>
A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.
failure_reason: Option<FailureReason>
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 Certificate Manager User Guide.
type: Option<CertificateType>
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 Certificate Manager User Guide.
renewal_summary: Option<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
.
key_usages: Option<Vec<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.
extended_key_usages: Option<Vec<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).
The Amazon Resource Name (ARN) of the 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
renewal_eligibility: Option<RenewalEligibility>
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate
command.
options: Option<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.
Implementations§
source§impl CertificateDetail
impl CertificateDetail
sourcepub fn certificate_arn(&self) -> Option<&str>
pub fn certificate_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
sourcepub fn domain_name(&self) -> Option<&str>
pub fn domain_name(&self) -> Option<&str>
The fully qualified domain name for the certificate, such as www.example.com or example.com.
sourcepub fn subject_alternative_names(&self) -> &[String]
pub fn subject_alternative_names(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .subject_alternative_names.is_none()
.
sourcepub fn domain_validation_options(&self) -> &[DomainValidation]
pub fn domain_validation_options(&self) -> &[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
.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .domain_validation_options.is_none()
.
sourcepub fn subject(&self) -> Option<&str>
pub fn subject(&self) -> Option<&str>
The name of the entity that is associated with the public key contained in the certificate.
sourcepub fn issuer(&self) -> Option<&str>
pub fn issuer(&self) -> Option<&str>
The name of the certificate authority that issued and signed the certificate.
sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The time at which the certificate was requested.
sourcepub fn issued_at(&self) -> Option<&DateTime>
pub fn issued_at(&self) -> Option<&DateTime>
The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED
.
sourcepub fn imported_at(&self) -> Option<&DateTime>
pub fn imported_at(&self) -> Option<&DateTime>
The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED
.
sourcepub fn status(&self) -> Option<&CertificateStatus>
pub fn status(&self) -> Option<&CertificateStatus>
The status of the certificate.
A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
sourcepub fn revoked_at(&self) -> Option<&DateTime>
pub fn revoked_at(&self) -> Option<&DateTime>
The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED
.
sourcepub fn revocation_reason(&self) -> Option<&RevocationReason>
pub fn revocation_reason(&self) -> Option<&RevocationReason>
The reason the certificate was revoked. This value exists only when the certificate status is REVOKED
.
sourcepub fn not_before(&self) -> Option<&DateTime>
pub fn not_before(&self) -> Option<&DateTime>
The time before which the certificate is not valid.
sourcepub fn not_after(&self) -> Option<&DateTime>
pub fn not_after(&self) -> Option<&DateTime>
The time after which the certificate is not valid.
sourcepub fn key_algorithm(&self) -> Option<&KeyAlgorithm>
pub fn key_algorithm(&self) -> Option<&KeyAlgorithm>
The algorithm that was used to generate the public-private key pair.
sourcepub fn signature_algorithm(&self) -> Option<&str>
pub fn signature_algorithm(&self) -> Option<&str>
The algorithm that was used to sign the certificate.
sourcepub fn in_use_by(&self) -> &[String]
pub fn in_use_by(&self) -> &[String]
A list of ARNs for the Amazon Web Services resources that are using the certificate. A certificate can be used by multiple Amazon Web Services resources.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .in_use_by.is_none()
.
sourcepub fn failure_reason(&self) -> Option<&FailureReason>
pub fn failure_reason(&self) -> Option<&FailureReason>
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 Certificate Manager User Guide.
sourcepub fn type(&self) -> Option<&CertificateType>
pub fn type(&self) -> Option<&CertificateType>
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 Certificate Manager User Guide.
sourcepub fn renewal_summary(&self) -> Option<&RenewalSummary>
pub fn renewal_summary(&self) -> Option<&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
.
sourcepub fn key_usages(&self) -> &[KeyUsage]
pub fn key_usages(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .key_usages.is_none()
.
sourcepub fn extended_key_usages(&self) -> &[ExtendedKeyUsage]
pub fn extended_key_usages(&self) -> &[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).
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .extended_key_usages.is_none()
.
The Amazon Resource Name (ARN) of the 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
sourcepub fn renewal_eligibility(&self) -> Option<&RenewalEligibility>
pub fn renewal_eligibility(&self) -> Option<&RenewalEligibility>
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate
command.
sourcepub fn options(&self) -> Option<&CertificateOptions>
pub fn options(&self) -> Option<&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.
source§impl CertificateDetail
impl CertificateDetail
sourcepub fn builder() -> CertificateDetailBuilder
pub fn builder() -> CertificateDetailBuilder
Creates a new builder-style object to manufacture CertificateDetail
.
Trait Implementations§
source§impl Clone for CertificateDetail
impl Clone for CertificateDetail
source§fn clone(&self) -> CertificateDetail
fn clone(&self) -> CertificateDetail
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for CertificateDetail
impl Debug for CertificateDetail
source§impl PartialEq for CertificateDetail
impl PartialEq for CertificateDetail
source§fn eq(&self, other: &CertificateDetail) -> bool
fn eq(&self, other: &CertificateDetail) -> bool
self
and other
values to be equal, and is used
by ==
.