Package software.amazon.awscdk.services.iot

Interface CfnPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.984Z")
@Stability(Stable)
public interface CfnPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPolicy.

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;
 CfnPolicyProps cfnPolicyProps = CfnPolicyProps.builder()
         .policyDocument(policyDocument)
         // the properties below are optional
         .policyName("policyName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPolicyProps.Builder	A builder for CfnPolicyProps
static final class	CfnPolicyProps.Jsii$Proxy	An implementation for CfnPolicyProps

Method Summary

Modifier and Type	Method	Description
static CfnPolicyProps.Builder	builder()
Object	getPolicyDocument()	The JSON document that describes the policy.
default String	getPolicyName()	The policy name.
default List<CfnTag>	getTags()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyDocument

@Stability(Stable)
@NotNull
Object getPolicyDocument()

The JSON document that describes the policy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-policydocument

getPolicyName

@Stability(Stable)
@Nullable
default String getPolicyName()

The policy name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-policyname

getTags

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-policy.html#cfn-iot-policy-tags

builder

@Stability(Stable)
static CfnPolicyProps.Builder builder()

Returns:

a CfnPolicyProps.Builder of CfnPolicyProps