Class CertificateDetail

java.lang.Object
software.amazon.awssdk.services.acm.model.CertificateDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CertificateDetail.Builder,CertificateDetail>
@Generated("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:

  • Method Details

    • certificateArn

      public 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.

      Returns:
      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.

    • domainName

      public final 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.

    • hasSubjectAlternativeNames

      public final boolean hasSubjectAlternativeNames()
      For responses, this returns true if the service returned a value for the SubjectAlternativeNames property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • subjectAlternativeNames

      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.

      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.

    • hasDomainValidationOptions

      public final boolean hasDomainValidationOptions()
      For responses, this returns true if the service returned a value for the DomainValidationOptions property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • domainValidationOptions

      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.

      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 final String serial()

      The serial number of the certificate.

      Returns:
      The serial number of the certificate.

    • subject

      public final 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 final 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 final Instant createdAt()

      The time at which the certificate was requested.

      Returns:
      The time at which the certificate was requested.

    • issuedAt

      public final 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 final Instant importedAt()

      The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

      Returns:
      The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

    • status

      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().

      Returns:
      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.

      See Also:

    • statusAsString

      public 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().

      Returns:
      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.

      See Also:

    • revokedAt

      public final 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 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().

      Returns:
      The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
      See Also:

    • revocationReasonAsString

      public 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().

      Returns:
      The reason the certificate was revoked. This value exists only when the certificate status is REVOKED.
      See Also:

    • notBefore

      public final Instant notBefore()

      The time before which the certificate is not valid.

      Returns:
      The time before which the certificate is not valid.

    • notAfter

      public final Instant notAfter()

      The time after which the certificate is not valid.

      Returns:
      The time after which the certificate is not valid.

    • keyAlgorithm

      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().

      Returns:
      The algorithm that was used to generate the public-private key pair.
      See Also:

    • keyAlgorithmAsString

      public 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().

      Returns:
      The algorithm that was used to generate the public-private key pair.
      See Also:

    • signatureAlgorithm

      public final String signatureAlgorithm()

      The algorithm that was used to sign the certificate.

      Returns:
      The algorithm that was used to sign the certificate.

    • hasInUseBy

      public final boolean hasInUseBy()
      For responses, this returns true if the service returned a value for the InUseBy property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • inUseBy

      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.

      Returns:
      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.

    • failureReason

      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().

      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 Certificate Manager User Guide.
      See Also:

    • failureReasonAsString

      public 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().

      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 Certificate Manager User Guide.
      See Also:

    • type

      public 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().

      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 Certificate Manager User Guide.
      See Also:

    • typeAsString

      public 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().

      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 Certificate Manager User Guide.
      See Also:

    • renewalSummary

      public 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.

      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.

    • hasKeyUsages

      public final boolean hasKeyUsages()
      For responses, this returns true if the service returned a value for the KeyUsages property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • keyUsages

      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.

      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.

    • hasExtendedKeyUsages

      public final boolean hasExtendedKeyUsages()
      For responses, this returns true if the service returned a value for the ExtendedKeyUsages property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • extendedKeyUsages

      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.

      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 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

      Returns:
      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

    • renewalEligibility

      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().

      Returns:
      Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
      See Also:

    • renewalEligibilityAsString

      public 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().

      Returns:
      Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.
      See Also:

    • options

      public 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.

      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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final 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.