Class CfnPolicy

All Implemented Interfaces:
IConstruct, IDependable, IInspectable,, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.585Z") @Stability(Stable) public class CfnPolicy extends CfnResource implements IInspectable
A CloudFormation AWS::IoT::Policy.

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 .


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 Object policyDocument;
 CfnPolicy cfnPolicy = CfnPolicy.Builder.create(this, "MyCfnPolicy")
         // the properties below are optional
  • Field Details


      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnPolicy

      protected CfnPolicy( objRef)
    • CfnPolicy

      protected CfnPolicy( initializationMode)
    • CfnPolicy

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

      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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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)
      renderProperties in class CfnResource
      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.
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      getCfnProperties in class CfnResource
    • 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.