Package software.amazon.awssdk.services.securityhub.model

Class AwsCertificateManagerCertificateDetails

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

Provides details about an Certificate Manager certificate.

See Also:

  • Method Details

    • certificateAuthorityArn

      public final String certificateAuthorityArn()

      The ARN of the private certificate authority (CA) that will be used to issue the certificate.

      Returns:
      The ARN of the private certificate authority (CA) that will be used to issue the certificate.

    • createdAt

      public final String createdAt()

      Indicates when the certificate was requested.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Returns:
      Indicates when the certificate was requested.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

    • domainName

      public final String domainName()

      The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

      Returns:
      The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

    • 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<AwsCertificateManagerCertificateDomainValidationOption> domainValidationOptions()

      Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request.

      Only provided if 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.

      Only provided if the certificate type is AMAZON_ISSUED.

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

    • failureReason

      public final String failureReason()

      For a failed certificate request, the reason for the failure.

      Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

      Returns:
      For a failed certificate request, the reason for the failure.

      Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

    • importedAt

      public final String importedAt()

      Indicates when the certificate was imported. Provided if the certificate type is IMPORTED.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Returns:
      Indicates when the certificate was imported. Provided if the certificate type is IMPORTED .

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

      The list of ARNs for the Amazon Web Services resources that use the certificate.

      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:
      The list of ARNs for the Amazon Web Services resources that use the certificate.

    • issuedAt

      public final String issuedAt()

      Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Returns:
      Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED .

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

    • keyAlgorithm

      public final String keyAlgorithm()

      The algorithm that was used to generate the public-private key pair.

      Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

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

      Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1

    • 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<AwsCertificateManagerCertificateKeyUsage> keyUsages()

      A list of key usage X.509 v3 extension objects.

      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.

    • notAfter

      public final String notAfter()

      The time after which the certificate becomes invalid.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

      Returns:
      The time after which the certificate becomes invalid.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

    • notBefore

      public final String notBefore()

      The time before which the certificate is not valid.

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

      This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

      • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

      • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

      • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

      • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

    • options

      public final AwsCertificateManagerCertificateOptions options()

      Provides a value that specifies whether to add the certificate to a transparency log.

      Returns:
      Provides a value that specifies whether to add the certificate to a transparency log.

    • renewalEligibility

      public final String renewalEligibility()

      Whether the certificate is eligible for renewal.

      Valid values: ELIGIBLE | INELIGIBLE

      Returns:
      Whether the certificate is eligible for renewal.

      Valid values: ELIGIBLE | INELIGIBLE

    • renewalSummary

      public final AwsCertificateManagerCertificateRenewalSummary renewalSummary()

      Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.

      Returns:
      Information about the status of the Certificate Manager managed renewal for the certificate. Provided 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.

    • signatureAlgorithm

      public final String signatureAlgorithm()

      The algorithm that was used to sign the certificate.

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

    • status

      public final String status()

      The status of the certificate.

      Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

      Returns:
      The status of the certificate.

      Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED

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

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

    • type

      public final String type()

      The source of the certificate. For certificates that Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

      Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE

      Returns:
      The source of the certificate. For certificates that Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED.

      Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE

    • toBuilder

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

    • builder

      public static AwsCertificateManagerCertificateDetails.Builder builder()

    • serializableBuilderClass

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