Package software.amazon.awscdk.services.iot

Class CfnPolicy

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.CfnPolicy
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IPolicyRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:15.145Z") @Stability(Stable) public class CfnPolicy extends CfnResource implements IInspectable, IPolicyRef, ITaggableV2
Use the AWS::IoT::Policy resource to declare an AWS IoT policy.

For more information about working with AWS IoT policies, see Authorization in the AWS IoT 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.*;
 Object policyDocument;
 CfnPolicy cfnPolicy = CfnPolicy.Builder.create(this, "MyCfnPolicy")
         .policyDocument(policyDocument)
         // the properties below are optional
         .policyName("policyName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnPolicy

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

    • CfnPolicy

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

    • CfnPolicy

      @Stability(Stable) public CfnPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPolicyProps props)
      Create a new AWS::IoT::Policy.

      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

    • arnForPolicy

      @Stability(Stable) @NotNull public static String arnForPolicy(@NotNull IPolicyRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnPolicy

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

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the AWS IoT policy, such as arn:aws:iot:us-east-2:123456789012:policy/MyPolicy .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The name of this policy.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPolicyRef

      @Stability(Stable) @NotNull public PolicyReference getPolicyRef()
      A reference to a Policy resource.
      Specified by:
      getPolicyRef in interface IPolicyRef

    • getPolicyDocument

      @Stability(Stable) @NotNull public Object getPolicyDocument()
      The JSON document that describes the policy.

    • setPolicyDocument

      @Stability(Stable) public void setPolicyDocument(@NotNull Object value)
      The JSON document that describes the policy.

    • getPolicyName

      @Stability(Stable) @Nullable public String getPolicyName()
      The policy name.

    • setPolicyName

      @Stability(Stable) public void setPolicyName(@Nullable String value)
      The policy name.

    • getTags

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

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)