Package software.amazon.awssdk.services.iot.model

Class CertificateDescription

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

Describes a certificate.

See Also:

  • Method Details

    • certificateArn

      public final String certificateArn()

      The ARN of the certificate.

      Returns:
      The ARN of the certificate.

    • certificateId

      public final String certificateId()

      The ID of the certificate.

      Returns:
      The ID of the certificate.

    • caCertificateId

      public final String caCertificateId()

      The certificate ID of the CA certificate used to sign this certificate.

      Returns:
      The certificate ID of the CA certificate used to sign this certificate.

    • status

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

    • statusAsString

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

    • certificatePem

      public final String certificatePem()

      The certificate data, in PEM format.

      Returns:
      The certificate data, in PEM format.

    • ownedBy

      public final String ownedBy()

      The ID of the Amazon Web Services account that owns the certificate.

      Returns:
      The ID of the Amazon Web Services account that owns the certificate.

    • previousOwnedBy

      public final String previousOwnedBy()

      The ID of the Amazon Web Services account of the previous owner of the certificate.

      Returns:
      The ID of the Amazon Web Services account of the previous owner of the certificate.

    • creationDate

      public final Instant creationDate()

      The date and time the certificate was created.

      Returns:
      The date and time the certificate was created.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date and time the certificate was last modified.

      Returns:
      The date and time the certificate was last modified.

    • customerVersion

      public final Integer customerVersion()

      The customer version of the certificate.

      Returns:
      The customer version of the certificate.

    • transferData

      public final TransferData transferData()

      The transfer data.

      Returns:
      The transfer data.

    • generationId

      public final String generationId()

      The generation ID of the certificate.

      Returns:
      The generation ID of the certificate.

    • validity

      public final CertificateValidity validity()

      When the certificate is valid.

      Returns:
      When the certificate is valid.

    • certificateMode

      public final CertificateMode certificateMode()

      The mode of the certificate.

      DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

      SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

      For more information about the value for SNI extension, see Transport security in IoT.

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

      Returns:
      The mode of the certificate.

      DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

      SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

      For more information about the value for SNI extension, see Transport security in IoT.

      See Also:

    • certificateModeAsString

      public final String certificateModeAsString()

      The mode of the certificate.

      DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

      SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

      For more information about the value for SNI extension, see Transport security in IoT.

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

      Returns:
      The mode of the certificate.

      DEFAULT: A certificate in DEFAULT mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) in DEFAULT mode. Devices with certificates in DEFAULT mode aren't required to send the Server Name Indication (SNI) extension when connecting to Amazon Web Services IoT Core. However, to use features such as custom domains and VPC endpoints, we recommend that you use the SNI extension when connecting to Amazon Web Services IoT Core.

      SNI_ONLY: A certificate in SNI_ONLY mode is registered without an issuer CA. Devices with certificates in SNI_ONLY mode must send the SNI extension when connecting to Amazon Web Services IoT Core.

      For more information about the value for SNI extension, see Transport security in IoT.

      See Also:

    • toBuilder

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

    • builder

      public static CertificateDescription.Builder builder()

    • serializableBuilderClass

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