Class AcmCertificateMetadata

java.lang.Object
software.amazon.awssdk.services.acm.model.AcmCertificateMetadata
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AcmCertificateMetadata.Builder,AcmCertificateMetadata>
@Generated("software.amazon.awssdk:codegen") public final class AcmCertificateMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AcmCertificateMetadata.Builder,AcmCertificateMetadata>

Contains ACM-specific metadata about a certificate.

See Also:

  • Method Details

    • createdAt

      public final Instant createdAt()

      The time at which the certificate was requested.

      Returns:
      The time at which the certificate was requested.

    • exported

      public final Boolean exported()

      Indicates whether the certificate has been exported.

      Returns:
      Indicates whether the certificate has been exported.

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

    • inUse

      public final Boolean inUse()

      Indicates whether the certificate is currently in use by an Amazon Web Services service.

      Returns:
      Indicates whether the certificate is currently in use by an Amazon Web Services service.

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

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

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

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

    • renewalStatus

      public final RenewalStatus renewalStatus()

      The renewal status of the certificate.

      If the service returns an enum value that is not available in the current SDK version, renewalStatus will return RenewalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from renewalStatusAsString().

      Returns:
      The renewal status of the certificate.
      See Also:

    • renewalStatusAsString

      public final String renewalStatusAsString()

      The renewal status of the certificate.

      If the service returns an enum value that is not available in the current SDK version, renewalStatus will return RenewalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from renewalStatusAsString().

      Returns:
      The renewal status of the certificate.
      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:

    • exportOption

      public final CertificateExport exportOption()

      Indicates whether the certificate can be exported.

      If the service returns an enum value that is not available in the current SDK version, exportOption will return CertificateExport.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportOptionAsString().

      Returns:
      Indicates whether the certificate can be exported.
      See Also:

    • exportOptionAsString

      public final String exportOptionAsString()

      Indicates whether the certificate can be exported.

      If the service returns an enum value that is not available in the current SDK version, exportOption will return CertificateExport.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from exportOptionAsString().

      Returns:
      Indicates whether the certificate can be exported.
      See Also:

    • managedBy

      public final CertificateManagedBy managedBy()

      Identifies the Amazon Web Services service that manages the certificate issued by ACM.

      If the service returns an enum value that is not available in the current SDK version, managedBy will return CertificateManagedBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedByAsString().

      Returns:
      Identifies the Amazon Web Services service that manages the certificate issued by ACM.
      See Also:

    • managedByAsString

      public final String managedByAsString()

      Identifies the Amazon Web Services service that manages the certificate issued by ACM.

      If the service returns an enum value that is not available in the current SDK version, managedBy will return CertificateManagedBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from managedByAsString().

      Returns:
      Identifies the Amazon Web Services service that manages the certificate issued by ACM.
      See Also:

    • validationMethod

      public final ValidationMethod validationMethod()

      Specifies the domain validation method.

      If the service returns an enum value that is not available in the current SDK version, validationMethod will return ValidationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validationMethodAsString().

      Returns:
      Specifies the domain validation method.
      See Also:

    • validationMethodAsString

      public final String validationMethodAsString()

      Specifies the domain validation method.

      If the service returns an enum value that is not available in the current SDK version, validationMethod will return ValidationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validationMethodAsString().

      Returns:
      Specifies the domain validation method.
      See Also:

    • toBuilder

      public AcmCertificateMetadata.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<AcmCertificateMetadata.Builder,AcmCertificateMetadata>
      Returns:
      a builder for type T

    • builder

      public static AcmCertificateMetadata.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AcmCertificateMetadata.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.