Package software.amazon.awscdk.services.iot

Interface CfnCertificateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:18.253Z")
@Stability(Stable)
public interface CfnCertificateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCertificate.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 CfnCertificateProps cfnCertificateProps = CfnCertificateProps.builder()
         .status("status")
         // the properties below are optional
         .caCertificatePem("caCertificatePem")
         .certificateMode("certificateMode")
         .certificatePem("certificatePem")
         .certificateSigningRequest("certificateSigningRequest")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCertificateProps.Builder	A builder for CfnCertificateProps
static final class	CfnCertificateProps.Jsii$Proxy	An implementation for CfnCertificateProps

Method Summary

Modifier and Type	Method	Description
static CfnCertificateProps.Builder	builder()
default String	getCaCertificatePem()	The CA certificate used to sign the device certificate being registered, not available when CertificateMode is SNI_ONLY.
default String	getCertificateMode()	Specifies which mode of certificate registration to use with this resource.
default String	getCertificatePem()	The certificate data in PEM format.
default String	getCertificateSigningRequest()	The certificate signing request (CSR).
String	getStatus()	The status of the certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStatus

@Stability(Stable)
@NotNull
String getStatus()

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.

See Also:

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

getCaCertificatePem

@Stability(Stable)
@Nullable
default String getCaCertificatePem()

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

See Also:

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

getCertificateMode

@Stability(Stable)
@Nullable
default String getCertificateMode()

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 .

See Also:

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

getCertificatePem

@Stability(Stable)
@Nullable
default String getCertificatePem()

The certificate data in PEM format.

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

See Also:

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

getCertificateSigningRequest

@Stability(Stable)
@Nullable
default String getCertificateSigningRequest()

The certificate signing request (CSR).

See Also:

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

builder

@Stability(Stable)
static CfnCertificateProps.Builder builder()

Returns:

a CfnCertificateProps.Builder of CfnCertificateProps