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, IEnvironmentAware, IEncryptionConfigurationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:22.457Z") @Stability(Stable) public class CfnEncryptionConfiguration extends CfnResource implements IInspectable, IEncryptionConfigurationRef
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:

  • 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)
      Create a new AWS::IoT::EncryptionConfiguration.

      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

    • isCfnEncryptionConfiguration

      @Stability(Stable) @NotNull public static Boolean isCfnEncryptionConfiguration(@NotNull Object x)
      Checks whether the given object is a CfnEncryptionConfiguration.

      Parameters:
      x - This parameter is required.

    • 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

    • getEncryptionConfigurationRef

      @Stability(Stable) @NotNull public EncryptionConfigurationReference getEncryptionConfigurationRef()
      A reference to a EncryptionConfiguration resource.
      Specified by:
      getEncryptionConfigurationRef in interface IEncryptionConfigurationRef

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