CertificateDetail (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.acm.model.CertificateDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CertificateDetail.Builder,CertificateDetail>
```
@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CertificateDetail.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CertificateDetail.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 ACM PCA 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)`
`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)`
`int`	`hashCode()`
`Instant`	`importedAt()` The date and time at which the certificate was imported.
`List<String>`	`inUseBy()` A list of ARNs for the AWS 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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`CertificateType`	`type()` The source of the certificate.
`String`	`typeAsString()` The source of the certificate.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - certificateArn
```
public String certificateArn()
```
    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.
    
    Returns:
    
    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.
  - domainName
```
public String domainName()
```
    The fully qualified domain name for the certificate, such as www.example.com or example.com.
    
    Returns:
    
    The fully qualified domain name for the certificate, such as www.example.com or example.com.
  - subjectAlternativeNames
```
public 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.
    
    Returns:
    
    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.
  - domainValidationOptions
```
public 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.
    
    Returns:
    
    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
```
public String serial()
```
    The serial number of the certificate.
    
    Returns:
    
    The serial number of the certificate.
  - subject
```
public String subject()
```
    The name of the entity that is associated with the public key contained in the certificate.
    
    Returns:
    
    The name of the entity that is associated with the public key contained in the certificate.
  - issuer
```
public String issuer()
```
    The name of the certificate authority that issued and signed the certificate.
    
    Returns:
    
    The name of the certificate authority that issued and signed the certificate.
  - createdAt
```
public Instant createdAt()
```
    The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED.
    
    Returns:
    
    The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED.
  - issuedAt
```
public Instant issuedAt()
```
    The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
    
    Returns:
    
    The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.
  - importedAt
```
public Instant importedAt()
```
    The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.
    
    Returns:
    
    The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED.
  - status
```
public CertificateStatus status()
```
    The status of the certificate.
    
    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().
    
    Returns:
    
    The status of the certificate.
    
    See Also:
    
    CertificateStatus
  - statusAsString
```
public String statusAsString()
```
    The status of the certificate.
    
    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().
    
    Returns:
    
    The status of the certificate.
    
    See Also:
    
    CertificateStatus
  - revokedAt
```
public Instant revokedAt()
```
    The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
    
    Returns:
    
    The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.
  - revocationReason
```
public 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().
    
    Returns:
    
    The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
    
    See Also:
    
    RevocationReason
  - revocationReasonAsString
```
public 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().
    
    Returns:
    
    The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
    
    See Also:
    
    RevocationReason
  - notBefore
```
public Instant notBefore()
```
    The time before which the certificate is not valid.
    
    Returns:
    
    The time before which the certificate is not valid.
  - notAfter
```
public Instant notAfter()
```
    The time after which the certificate is not valid.
    
    Returns:
    
    The time after which the certificate is not valid.
  - keyAlgorithm
```
public 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().
    
    Returns:
    
    The algorithm that was used to generate the public-private key pair.
    
    See Also:
    
    KeyAlgorithm
  - keyAlgorithmAsString
```
public 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().
    
    Returns:
    
    The algorithm that was used to generate the public-private key pair.
    
    See Also:
    
    KeyAlgorithm
  - signatureAlgorithm
```
public String signatureAlgorithm()
```
    The algorithm that was used to sign the certificate.
    
    Returns:
    
    The algorithm that was used to sign the certificate.
  - inUseBy
```
public List<String> inUseBy()
```
    A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.
  - failureReason
```
public 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 AWS 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().
    
    Returns:
    
    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.
    
    See Also:
    
    FailureReason
  - failureReasonAsString
```
public 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 AWS 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().
    
    Returns:
    
    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.
    
    See Also:
    
    FailureReason
  - type
```
public 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 AWS 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().
    
    Returns:
    
    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.
    
    See Also:
    
    CertificateType
  - typeAsString
```
public 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 AWS 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().
    
    Returns:
    
    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.
    
    See Also:
    
    CertificateType
  - renewalSummary
```
public 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.
    
    Returns:
    
    Contains information about the status of ACM's managed renewal for the certificate. This field exists only when the certificate type is AMAZON_ISSUED.
  - keyUsages
```
public 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.
    
    Returns:
    
    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.
  - extendedKeyUsages
```
public 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.
    
    Returns:
    
    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).
  - certificateAuthorityArn
```
public String certificateAuthorityArn()
```
    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
    
    Returns:
    
    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
  - renewalEligibility
```
public RenewalEligibility renewalEligibility()
```
    Specifies whether the certificate is eligible for renewal.
    
    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().
    
    Returns:
    
    Specifies whether the certificate is eligible for renewal.
    
    See Also:
    
    RenewalEligibility
  - renewalEligibilityAsString
```
public String renewalEligibilityAsString()
```
    Specifies whether the certificate is eligible for renewal.
    
    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().
    
    Returns:
    
    Specifies whether the certificate is eligible for renewal.
    
    See Also:
    
    RenewalEligibility
  - options
```
public 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.
    
    Returns:
    
    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.
  - toBuilder
```
public CertificateDetail.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CertificateDetail.Builder,CertificateDetail>
    
    Returns:
    
    a builder for type T
  - builder
```
public static CertificateDetail.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CertificateDetail.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class CertificateDetail

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

certificateArn

domainName

subjectAlternativeNames

domainValidationOptions

serial

subject

issuer

createdAt

issuedAt

importedAt

status

statusAsString

revokedAt

revocationReason

revocationReasonAsString

notBefore

notAfter

keyAlgorithm

keyAlgorithmAsString

signatureAlgorithm

inUseBy

failureReason

failureReasonAsString

type

typeAsString

renewalSummary

keyUsages

extendedKeyUsages

certificateAuthorityArn

renewalEligibility

renewalEligibilityAsString

options

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields