software.amazon.awscdk.services.iot

Class CfnCACertificate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.iot.CfnCACertificate

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-02T14:17:13.855Z")
 @Stability(value=Stable)
public class CfnCACertificate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::CACertificate`.

Specifies a CA certificate.

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.*;
 CfnCACertificate cfnCACertificate = CfnCACertificate.Builder.create(this, "MyCfnCACertificate")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCACertificate.Builder A fluent builder for CfnCACertificate.
static interface	CfnCACertificate.RegistrationConfigProperty The registration configuration.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCACertificate(Construct scope, String id, CfnCACertificateProps props) Create a new `AWS::IoT::CACertificate`.
protected	CfnCACertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCACertificate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() Returns the Amazon Resource Name (ARN) for the CA certificate.
String	getAttrId() The CA certificate ID.
String	getAutoRegistrationStatus() Whether the CA certificate is configured for auto registration of device certificates.
String	getCaCertificatePem() The certificate data in PEM format.
String	getCertificateMode() The mode of the CA.
protected Map<String,Object>	getCfnProperties()
Object	getRegistrationConfig() Information about the registration configuration.
Object	getRemoveAutoRegistration() If true, removes auto registration.
String	getStatus() The status of the CA certificate.
TagManager	getTags() An array of key-value pairs to apply to this resource.
String	getVerificationCertificatePem() The private key verification certificate.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAutoRegistrationStatus(String value) Whether the CA certificate is configured for auto registration of device certificates.
void	setCaCertificatePem(String value) The certificate data in PEM format.
void	setCertificateMode(String value) The mode of the CA.
void	setRegistrationConfig(CfnCACertificate.RegistrationConfigProperty value) Information about the registration configuration.
void	setRegistrationConfig(IResolvable value) Information about the registration configuration.
void	setRemoveAutoRegistration(Boolean value) If true, removes auto registration.
void	setRemoveAutoRegistration(IResolvable value) If true, removes auto registration.
void	setStatus(String value) The status of the CA certificate.
void	setVerificationCertificatePem(String value) The private key verification certificate.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCACertificate

protected CfnCACertificate(software.amazon.jsii.JsiiObjectRef objRef)

CfnCACertificate

protected CfnCACertificate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCACertificate

@Stability(value=Stable)
public CfnCACertificate(@NotNull
                                                 Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnCACertificateProps props)

Create a new `AWS::IoT::CACertificate`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

Returns the Amazon Resource Name (ARN) for the CA certificate. For example:.

{ "Fn::GetAtt": ["MyCACertificate", "Arn"] }

A value similar to the following is returned:

arn:aws:iot:us-east-1:123456789012:cacert/a6be6b84559801927e35a8f901fae08b5971d78d1562e29504ff9663b276a5f5

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The CA certificate ID.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

For more information, see Tag .

getCaCertificatePem

@Stability(value=Stable)
 @NotNull
public String getCaCertificatePem()

The certificate data in PEM format.

setCaCertificatePem

@Stability(value=Stable)
public void setCaCertificatePem(@NotNull
                                                         String value)

The certificate data in PEM format.

getStatus

@Stability(value=Stable)
 @NotNull
public String getStatus()

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

setStatus

@Stability(value=Stable)
public void setStatus(@NotNull
                                               String value)

The status of the CA certificate.

Valid values are "ACTIVE" and "INACTIVE".

getAutoRegistrationStatus

@Stability(value=Stable)
 @Nullable
public String getAutoRegistrationStatus()

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

Valid values are "ENABLE" and "DISABLE".

setAutoRegistrationStatus

@Stability(value=Stable)
public void setAutoRegistrationStatus(@Nullable
                                                               String value)

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

Valid values are "ENABLE" and "DISABLE".

getCertificateMode

@Stability(value=Stable)
 @Nullable
public 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".

setCertificateMode

@Stability(value=Stable)
public void setCertificateMode(@Nullable
                                                        String value)

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".

getRegistrationConfig

@Stability(value=Stable)
 @Nullable
public Object getRegistrationConfig()

Information about the registration configuration.

setRegistrationConfig

@Stability(value=Stable)
public void setRegistrationConfig(@Nullable
                                                           IResolvable value)

Information about the registration configuration.

setRegistrationConfig

@Stability(value=Stable)
public void setRegistrationConfig(@Nullable
                                                           CfnCACertificate.RegistrationConfigProperty value)

Information about the registration configuration.

getRemoveAutoRegistration

@Stability(value=Stable)
 @Nullable
public Object getRemoveAutoRegistration()

If true, removes auto registration.

setRemoveAutoRegistration

@Stability(value=Stable)
public void setRemoveAutoRegistration(@Nullable
                                                               Boolean value)

If true, removes auto registration.

setRemoveAutoRegistration

@Stability(value=Stable)
public void setRemoveAutoRegistration(@Nullable
                                                               IResolvable value)

If true, removes auto registration.

getVerificationCertificatePem

@Stability(value=Stable)
 @Nullable
public String getVerificationCertificatePem()

The private key verification certificate.

setVerificationCertificatePem

@Stability(value=Stable)
public void setVerificationCertificatePem(@Nullable
                                                                   String value)

The private key verification certificate.