@Generated(value="software.amazon.awssdk:codegen") public final class CertificateDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CertificateDetail.Builder,CertificateDetail>
Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CertificateDetail.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CertificateDetail.Builder |
builder() |
String |
certificateArn()
The Amazon Resource Name (ARN) of the certificate.
|
String |
certificateAuthorityArn()
The Amazon Resource Name (ARN) of the private certificate authority (CA) that issued the certificate.
|
Instant |
createdAt()
The time at which the certificate was requested.
|
String |
domainName()
The fully qualified domain name for the certificate, such as www.example.com or example.com.
|
List<DomainValidation> |
domainValidationOptions()
Contains information about the initial validation of each domain name that occurs as a result of the
RequestCertificate request.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
List<ExtendedKeyUsage> |
extendedKeyUsages()
Contains a list of Extended Key Usage X.509 v3 extension objects.
|
FailureReason |
failureReason()
The reason the certificate request failed.
|
String |
failureReasonAsString()
The reason the certificate request failed.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasDomainValidationOptions()
For responses, this returns true if the service returned a value for the DomainValidationOptions property.
|
boolean |
hasExtendedKeyUsages()
For responses, this returns true if the service returned a value for the ExtendedKeyUsages property.
|
int |
hashCode() |
boolean |
hasInUseBy()
For responses, this returns true if the service returned a value for the InUseBy property.
|
boolean |
hasKeyUsages()
For responses, this returns true if the service returned a value for the KeyUsages property.
|
boolean |
hasSubjectAlternativeNames()
For responses, this returns true if the service returned a value for the SubjectAlternativeNames property.
|
Instant |
importedAt()
The date and time when the certificate was imported.
|
List<String> |
inUseBy()
A list of ARNs for the Amazon Web Services resources that are using the certificate.
|
Instant |
issuedAt()
The time at which the certificate was issued.
|
String |
issuer()
The name of the certificate authority that issued and signed the certificate.
|
KeyAlgorithm |
keyAlgorithm()
The algorithm that was used to generate the public-private key pair.
|
String |
keyAlgorithmAsString()
The algorithm that was used to generate the public-private key pair.
|
List<KeyUsage> |
keyUsages()
A list of Key Usage X.509 v3 extension objects.
|
Instant |
notAfter()
The time after which the certificate is not valid.
|
Instant |
notBefore()
The time before which the certificate is not valid.
|
CertificateOptions |
options()
Value that specifies whether to add the certificate to a transparency log.
|
RenewalEligibility |
renewalEligibility()
Specifies whether the certificate is eligible for renewal.
|
String |
renewalEligibilityAsString()
Specifies whether the certificate is eligible for renewal.
|
RenewalSummary |
renewalSummary()
Contains information about the status of ACM's managed renewal for the certificate.
|
RevocationReason |
revocationReason()
The reason the certificate was revoked.
|
String |
revocationReasonAsString()
The reason the certificate was revoked.
|
Instant |
revokedAt()
The time at which the certificate was revoked.
|
List<SdkField<?>> |
sdkFields() |
String |
serial()
The serial number of the certificate.
|
static Class<? extends CertificateDetail.Builder> |
serializableBuilderClass() |
String |
signatureAlgorithm()
The algorithm that was used to sign the certificate.
|
CertificateStatus |
status()
The status of the certificate.
|
String |
statusAsString()
The status of the certificate.
|
String |
subject()
The name of the entity that is associated with the public key contained in the certificate.
|
List<String> |
subjectAlternativeNames()
One or more domain names (subject alternative names) included in the certificate.
|
CertificateDetail.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
CertificateType |
type()
The source of the certificate.
|
String |
typeAsString()
The source of the certificate.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String certificateArn()
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.
public final String domainName()
The fully qualified domain name for the certificate, such as www.example.com or example.com.
public final boolean hasSubjectAlternativeNames()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<String> subjectAlternativeNames()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSubjectAlternativeNames() method.
public final boolean hasDomainValidationOptions()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<DomainValidation> domainValidationOptions()
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
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDomainValidationOptions() method.
AMAZON_ISSUED.public final String serial()
The serial number of the certificate.
public final String subject()
The name of the entity that is associated with the public key contained in the certificate.
public final String issuer()
The name of the certificate authority that issued and signed the certificate.
public final Instant createdAt()
The time at which the certificate was requested.
public final Instant issuedAt()
The time at which the certificate was issued. This value exists only when the certificate type is
AMAZON_ISSUED.
AMAZON_ISSUED.public final Instant importedAt()
The date and time when the certificate was imported. This value exists only when the certificate type is
IMPORTED.
IMPORTED.public final CertificateStatus status()
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.
If the service returns an enum value that is not available in the current SDK version, status will
return CertificateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
statusAsString().
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.
CertificateStatuspublic final String statusAsString()
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.
If the service returns an enum value that is not available in the current SDK version, status will
return CertificateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
statusAsString().
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.
CertificateStatuspublic final Instant revokedAt()
The time at which the certificate was revoked. This value exists only when the certificate status is
REVOKED.
REVOKED.public final RevocationReason revocationReason()
The reason the certificate was revoked. This value exists only when the certificate status is
REVOKED.
If the service returns an enum value that is not available in the current SDK version, revocationReason
will return RevocationReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from revocationReasonAsString().
REVOKED.RevocationReasonpublic final String revocationReasonAsString()
The reason the certificate was revoked. This value exists only when the certificate status is
REVOKED.
If the service returns an enum value that is not available in the current SDK version, revocationReason
will return RevocationReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available
from revocationReasonAsString().
REVOKED.RevocationReasonpublic final Instant notBefore()
The time before which the certificate is not valid.
public final Instant notAfter()
The time after which the certificate is not valid.
public final KeyAlgorithm keyAlgorithm()
The algorithm that was used to generate the public-private key pair.
If the service returns an enum value that is not available in the current SDK version, keyAlgorithm will
return KeyAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
keyAlgorithmAsString().
KeyAlgorithmpublic final String keyAlgorithmAsString()
The algorithm that was used to generate the public-private key pair.
If the service returns an enum value that is not available in the current SDK version, keyAlgorithm will
return KeyAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
keyAlgorithmAsString().
KeyAlgorithmpublic final String signatureAlgorithm()
The algorithm that was used to sign the certificate.
public final boolean hasInUseBy()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<String> inUseBy()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasInUseBy() method.
public final FailureReason 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.
If the service returns an enum value that is not available in the current SDK version, failureReason
will return FailureReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
failureReasonAsString().
FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.FailureReasonpublic final String failureReasonAsString()
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.
If the service returns an enum value that is not available in the current SDK version, failureReason
will return FailureReason.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
failureReasonAsString().
FAILED. For more information, see Certificate Request Failed in the Certificate Manager User Guide.FailureReasonpublic final CertificateType type()
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.
If the service returns an enum value that is not available in the current SDK version, type will return
CertificateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
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.CertificateTypepublic final String typeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, type will return
CertificateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
typeAsString().
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.CertificateTypepublic final RenewalSummary 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.
AMAZON_ISSUED.public final boolean hasKeyUsages()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<KeyUsage> keyUsages()
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasKeyUsages() method.
public final boolean hasExtendedKeyUsages()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<ExtendedKeyUsage> extendedKeyUsages()
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).
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasExtendedKeyUsages() method.
public final String certificateAuthorityArn()
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
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
public final RenewalEligibility renewalEligibility()
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
If the service returns an enum value that is not available in the current SDK version,
renewalEligibility will return RenewalEligibility.UNKNOWN_TO_SDK_VERSION. The raw value returned
by the service is available from renewalEligibilityAsString().
RenewalEligibilitypublic final String renewalEligibilityAsString()
Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
If the service returns an enum value that is not available in the current SDK version,
renewalEligibility will return RenewalEligibility.UNKNOWN_TO_SDK_VERSION. The raw value returned
by the service is available from renewalEligibilityAsString().
RenewalEligibilitypublic final CertificateOptions options()
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.
public CertificateDetail.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CertificateDetail.Builder,CertificateDetail>public static CertificateDetail.Builder builder()
public static Class<? extends CertificateDetail.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.