Package software.amazon.awscdk.services.iot

Class CfnCertificate.Builder

java.lang.Object

software.amazon.awscdk.services.iot.CfnCertificate.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCertificate>

Enclosing class:

CfnCertificate

@Stability(Stable)
public static final class CfnCertificate.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCertificate>

A fluent builder for CfnCertificate.

Method Summary

Modifier and Type	Method	Description
CfnCertificate	build()
CfnCertificate.Builder	caCertificatePem(String caCertificatePem)	The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
CfnCertificate.Builder	certificateMode(String certificateMode)	Specifies which mode of certificate registration to use with this resource.
CfnCertificate.Builder	certificatePem(String certificatePem)	The certificate data in PEM format.
CfnCertificate.Builder	certificateSigningRequest(String certificateSigningRequest)	The certificate signing request (CSR).
static CfnCertificate.Builder	create(software.constructs.Construct scope, String id)
CfnCertificate.Builder	status(String status)	The status of the certificate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCertificate.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCertificate.Builder.

status

@Stability(Stable)
public CfnCertificate.Builder status(String status)

The status of the certificate.

Valid values are ACTIVE, INACTIVE, REVOKED, PENDING_TRANSFER, and PENDING_ACTIVATION.

The status value REGISTER_INACTIVE is deprecated and should not be used.

Parameters:

status - The status of the certificate. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-status

caCertificatePem

@Stability(Stable)
public CfnCertificate.Builder caCertificatePem(String caCertificatePem)

The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.

Parameters:

caCertificatePem - The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-cacertificatepem

certificateMode

@Stability(Stable)
public CfnCertificate.Builder certificateMode(String certificateMode)

Specifies which mode of certificate registration to use with this resource.

Valid options are DEFAULT with CaCertificatePem and CertificatePem, SNI_ONLY with CertificatePem, and Default with CertificateSigningRequest.

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

Parameters:

certificateMode - Specifies which mode of certificate registration to use with this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-certificatemode

certificatePem

@Stability(Stable)
public CfnCertificate.Builder certificatePem(String certificatePem)

The certificate data in PEM format.

Requires SNI_ONLY for the certificate mode or the accompanying CACertificatePem for registration.

Parameters:

certificatePem - The certificate data in PEM format. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-certificatepem

certificateSigningRequest

@Stability(Stable)
public CfnCertificate.Builder certificateSigningRequest(String certificateSigningRequest)

The certificate signing request (CSR).

Parameters:

certificateSigningRequest - The certificate signing request (CSR). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-certificate.html#cfn-iot-certificate-certificatesigningrequest

build

@Stability(Stable)
public CfnCertificate build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCertificate>

Returns:

a newly built instance of CfnCertificate.