software.amazon.awssdk.services.iot.model

Interface CertificateDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CertificateDescription.Builder,CertificateDescription>, SdkBuilder<CertificateDescription.Builder,CertificateDescription>, SdkPojo

Enclosing class:

CertificateDescription

public static interface CertificateDescription.Builder
extends SdkPojo, CopyableBuilder<CertificateDescription.Builder,CertificateDescription>

Method Summary

Modifier and Type	Method and Description
CertificateDescription.Builder	caCertificateId(String caCertificateId) The certificate ID of the CA certificate used to sign this certificate.
CertificateDescription.Builder	certificateArn(String certificateArn) The ARN of the certificate.
CertificateDescription.Builder	certificateId(String certificateId) The ID of the certificate.
CertificateDescription.Builder	certificateMode(CertificateMode certificateMode) The mode of the certificate.
CertificateDescription.Builder	certificateMode(String certificateMode) The mode of the certificate.
CertificateDescription.Builder	certificatePem(String certificatePem) The certificate data, in PEM format.
CertificateDescription.Builder	creationDate(Instant creationDate) The date and time the certificate was created.
CertificateDescription.Builder	customerVersion(Integer customerVersion) The customer version of the certificate.
CertificateDescription.Builder	generationId(String generationId) The generation ID of the certificate.
CertificateDescription.Builder	lastModifiedDate(Instant lastModifiedDate) The date and time the certificate was last modified.
CertificateDescription.Builder	ownedBy(String ownedBy) The ID of the Amazon Web Services account that owns the certificate.
CertificateDescription.Builder	previousOwnedBy(String previousOwnedBy) The ID of the Amazon Web Services account of the previous owner of the certificate.
CertificateDescription.Builder	status(CertificateStatus status) The status of the certificate.
CertificateDescription.Builder	status(String status) The status of the certificate.
default CertificateDescription.Builder	transferData(Consumer<TransferData.Builder> transferData) The transfer data.
CertificateDescription.Builder	transferData(TransferData transferData) The transfer data.
CertificateDescription.Builder	validity(CertificateValidity validity) When the certificate is valid.
default CertificateDescription.Builder	validity(Consumer<CertificateValidity.Builder> validity) When the certificate is valid.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

certificateArn

CertificateDescription.Builder certificateArn(String certificateArn)

The ARN of the certificate.

Parameters:

certificateArn - The ARN of the certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateId

CertificateDescription.Builder certificateId(String certificateId)

The ID of the certificate.

Parameters:

certificateId - The ID of the certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

caCertificateId

CertificateDescription.Builder caCertificateId(String caCertificateId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

status

CertificateDescription.Builder status(String status)

The status of the certificate.

Parameters:

status - The status of the certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CertificateStatus, CertificateStatus

status

CertificateDescription.Builder status(CertificateStatus status)

The status of the certificate.

Parameters:

status - The status of the certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CertificateStatus, CertificateStatus

certificatePem

CertificateDescription.Builder certificatePem(String certificatePem)

The certificate data, in PEM format.

Parameters:

certificatePem - The certificate data, in PEM format.

Returns:

Returns a reference to this object so that method calls can be chained together.

ownedBy

CertificateDescription.Builder ownedBy(String ownedBy)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

previousOwnedBy

CertificateDescription.Builder previousOwnedBy(String previousOwnedBy)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

creationDate

CertificateDescription.Builder creationDate(Instant creationDate)

The date and time the certificate was created.

Parameters:

creationDate - The date and time the certificate was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedDate

CertificateDescription.Builder lastModifiedDate(Instant lastModifiedDate)

The date and time the certificate was last modified.

Parameters:

lastModifiedDate - The date and time the certificate was last modified.

Returns:

Returns a reference to this object so that method calls can be chained together.

customerVersion

CertificateDescription.Builder customerVersion(Integer customerVersion)

The customer version of the certificate.

Parameters:

customerVersion - The customer version of the certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

transferData

CertificateDescription.Builder transferData(TransferData transferData)

The transfer data.

Parameters:

transferData - The transfer data.

Returns:

Returns a reference to this object so that method calls can be chained together.

transferData

default CertificateDescription.Builder transferData(Consumer<TransferData.Builder> transferData)

The transfer data.

This is a convenience method that creates an instance of the TransferData.Builder avoiding the need to create one manually via TransferData.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to transferData(TransferData).

Parameters:

transferData - a consumer that will call methods on TransferData.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

transferData(TransferData)

generationId

CertificateDescription.Builder generationId(String generationId)

The generation ID of the certificate.

Parameters:

generationId - The generation ID of the certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

validity

CertificateDescription.Builder validity(CertificateValidity validity)

When the certificate is valid.

Parameters:

validity - When the certificate is valid.

Returns:

Returns a reference to this object so that method calls can be chained together.

validity

default CertificateDescription.Builder validity(Consumer<CertificateValidity.Builder> validity)

When the certificate is valid.

This is a convenience method that creates an instance of the CertificateValidity.Builder avoiding the need to create one manually via CertificateValidity.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to validity(CertificateValidity).

Parameters:

validity - a consumer that will call methods on CertificateValidity.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

validity(CertificateValidity)

certificateMode

CertificateDescription.Builder certificateMode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CertificateMode, CertificateMode

certificateMode

CertificateDescription.Builder certificateMode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CertificateMode, CertificateMode