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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CertificateDescription.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CertificateDescription.Builder
builder()
String
caCertificateId()
The certificate ID of the CA certificate used to sign this certificate.String
certificateArn()
The ARN of the certificate.String
certificateId()
The ID of the certificate.CertificateMode
certificateMode()
The mode of the certificate.String
certificateModeAsString()
The mode of the certificate.String
certificatePem()
The certificate data, in PEM format.Instant
creationDate()
The date and time the certificate was created.Integer
customerVersion()
The customer version of the certificate.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
generationId()
The generation ID of the certificate.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Instant
lastModifiedDate()
The date and time the certificate was last modified.String
ownedBy()
The ID of the Amazon Web Services account that owns the certificate.String
previousOwnedBy()
The ID of the Amazon Web Services account of the previous owner of the certificate.List<SdkField<?>>
sdkFields()
static Class<? extends CertificateDescription.Builder>
serializableBuilderClass()
CertificateStatus
status()
The status of the certificate.String
statusAsString()
The status of the certificate.CertificateDescription.Builder
toBuilder()
String
toString()
Returns a string representation of this object.TransferData
transferData()
The transfer data.CertificateValidity
validity()
When the certificate is valid.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 returnCertificateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the certificate.
- See Also:
CertificateStatus
-
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 returnCertificateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the certificate.
- See Also:
CertificateStatus
-
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 inDEFAULT
mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) inDEFAULT
mode. Devices with certificates inDEFAULT
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 inSNI_ONLY
mode is registered without an issuer CA. Devices with certificates inSNI_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 returnCertificateMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcertificateModeAsString()
.- Returns:
- The mode of the certificate.
DEFAULT
: A certificate inDEFAULT
mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) inDEFAULT
mode. Devices with certificates inDEFAULT
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 inSNI_ONLY
mode is registered without an issuer CA. Devices with certificates inSNI_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:
CertificateMode
-
certificateModeAsString
public final String certificateModeAsString()
The mode of the certificate.
DEFAULT
: A certificate inDEFAULT
mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) inDEFAULT
mode. Devices with certificates inDEFAULT
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 inSNI_ONLY
mode is registered without an issuer CA. Devices with certificates inSNI_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 returnCertificateMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcertificateModeAsString()
.- Returns:
- The mode of the certificate.
DEFAULT
: A certificate inDEFAULT
mode is either generated by Amazon Web Services IoT Core or registered with an issuer certificate authority (CA) inDEFAULT
mode. Devices with certificates inDEFAULT
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 inSNI_ONLY
mode is registered without an issuer CA. Devices with certificates inSNI_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:
CertificateMode
-
toBuilder
public CertificateDescription.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CertificateDescription.Builder,CertificateDescription>
-
builder
public static CertificateDescription.Builder builder()
-
serializableBuilderClass
public static Class<? extends CertificateDescription.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-