Package software.amazon.awscdk.services.iot

Interface CfnCACertificateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCACertificateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-04-10T22:22:29.091Z")
@Stability(Stable)
public interface CfnCACertificateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCACertificate.

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.*;
 CfnCACertificateProps cfnCACertificateProps = CfnCACertificateProps.builder()
         .caCertificatePem("caCertificatePem")
         .status("status")
         // the properties below are optional
         .autoRegistrationStatus("autoRegistrationStatus")
         .certificateMode("certificateMode")
         .registrationConfig(RegistrationConfigProperty.builder()
                 .roleArn("roleArn")
                 .templateBody("templateBody")
                 .templateName("templateName")
                 .build())
         .removeAutoRegistration(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .verificationCertificatePem("verificationCertificatePem")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnCACertificateProps.Builder	builder()
default String	getAutoRegistrationStatus()	Whether the CA certificate is configured for auto registration of device certificates.
String	getCaCertificatePem()	The certificate data in PEM format.
default String	getCertificateMode()	The mode of the CA.
default Object	getRegistrationConfig()	Information about the registration configuration.
default Object	getRemoveAutoRegistration()	If true, removes auto registration.
String	getStatus()	The status of the CA certificate.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getVerificationCertificatePem()	The private key verification certificate.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCaCertificatePem

@Stability(Stable)
@NotNull
String getCaCertificatePem()

The certificate data in PEM format.

See Also:

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

getStatus

@Stability(Stable)
@NotNull
String getStatus()

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

See Also:

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

getAutoRegistrationStatus

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

Whether the CA certificate is configured for auto registration of device certificates.

Valid values are "ENABLE" and "DISABLE".

See Also:

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

getCertificateMode

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

The mode of the CA.

All the device certificates that are registered using this CA will be registered in the same mode as the CA. For more information about certificate mode for device certificates, see certificate mode .

Valid values are "DEFAULT" and "SNI_ONLY".

See Also:

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

getRegistrationConfig

@Stability(Stable)
@Nullable
default Object getRegistrationConfig()

Information about the registration configuration.

See Also:

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

getRemoveAutoRegistration

@Stability(Stable)
@Nullable
default Object getRemoveAutoRegistration()

If true, removes auto registration.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

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

getVerificationCertificatePem

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

The private key verification certificate.

See Also:

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

builder

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

Returns:

a CfnCACertificateProps.Builder of CfnCACertificateProps