Package software.amazon.awscdk.services.iot

Class CfnEncryptionConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnEncryptionConfiguration

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:33.009Z")
@Stability(Stable)
public class CfnEncryptionConfiguration
extends CfnResource
implements IInspectable

Retrieves the encryption configuration for resources and data of your AWS account in AWS IoT Core .

For more information, see Data encryption at rest in the AWS IoT Core Developer Guide .

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.*;
 CfnEncryptionConfiguration cfnEncryptionConfiguration = CfnEncryptionConfiguration.Builder.create(this, "MyCfnEncryptionConfiguration")
         .encryptionType("encryptionType")
         // the properties below are optional
         .kmsAccessRoleArn("kmsAccessRoleArn")
         .kmsKeyArn("kmsKeyArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnEncryptionConfiguration.Builder	A fluent builder for CfnEncryptionConfiguration.
static interface	CfnEncryptionConfiguration.ConfigurationDetailsProperty	The encryption configuration details that include the status information of the AWS Key Management Service ( AWS KMS ) key and the AWS KMS access role.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnEncryptionConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEncryptionConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
	CfnEncryptionConfiguration(software.constructs.Construct scope, String id, CfnEncryptionConfigurationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrAccountId()	The unique identifier (ID) of an AWS account.
IResolvable	getAttrConfigurationDetails()
String	getAttrLastModifiedDate()	The date when encryption configuration is last updated.
protected Map<String,Object>	getCfnProperties()
String	getEncryptionType()	The type of the KMS key.
String	getKmsAccessRoleArn()	The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.
String	getKmsKeyArn()	The ARN of the customer managed KMS key.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEncryptionType(String value)	The type of the KMS key.
void	setKmsAccessRoleArn(String value)	The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.
void	setKmsKeyArn(String value)	The ARN of the customer managed KMS key.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnEncryptionConfiguration

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

CfnEncryptionConfiguration

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

CfnEncryptionConfiguration

@Stability(Stable)
public CfnEncryptionConfiguration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnEncryptionConfigurationProps props)

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.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAccountId

@Stability(Stable)
@NotNull
public String getAttrAccountId()

The unique identifier (ID) of an AWS account.

getAttrConfigurationDetails

@Stability(Stable)
@NotNull
public IResolvable getAttrConfigurationDetails()

getAttrLastModifiedDate

@Stability(Stable)
@NotNull
public String getAttrLastModifiedDate()

The date when encryption configuration is last updated.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getEncryptionType

@Stability(Stable)
@NotNull
public String getEncryptionType()

The type of the KMS key.

setEncryptionType

@Stability(Stable)
public void setEncryptionType(@NotNull
 String value)

The type of the KMS key.

getKmsAccessRoleArn

@Stability(Stable)
@Nullable
public String getKmsAccessRoleArn()

The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.

setKmsAccessRoleArn

@Stability(Stable)
public void setKmsAccessRoleArn(@Nullable
 String value)

The Amazon Resource Name (ARN) of the IAM role assumed by AWS IoT Core to call AWS KMS on behalf of the customer.

getKmsKeyArn

@Stability(Stable)
@Nullable
public String getKmsKeyArn()

The ARN of the customer managed KMS key.

setKmsKeyArn

@Stability(Stable)
public void setKmsKeyArn(@Nullable
 String value)

The ARN of the customer managed KMS key.