Package software.amazon.awscdk.services.iam

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.iam.CfnPolicy
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:44.374Z") @Stability(Stable) public class CfnPolicy extends CfnResource implements IInspectable
Adds or updates an inline policy document that is embedded in the specified IAM group, user or role.

An IAM user can also have a managed policy attached to it. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide .

The Groups, Roles, and Users properties are optional. However, you must specify at least one of these properties.

For information about policy documents see Creating IAM policies in the IAM User Guide .

For information about limits on the number of inline policies that you can embed in an identity, see Limitations on IAM Entities in the IAM User Guide .

This resource does not support drift detection . The following inline policy resource types support drift detection:

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.iam.*;
 Object policyDocument;
 CfnPolicy cfnPolicy = CfnPolicy.Builder.create(this, "MyCfnPolicy")
         .policyDocument(policyDocument)
         .policyName("policyName")
         // the properties below are optional
         .groups(List.of("groups"))
         .roles(List.of("roles"))
         .users(List.of("users"))
         .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)
      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.

    • getAttrId

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

    • getCfnProperties

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

    • getPolicyDocument

      @Stability(Stable) @NotNull public Object getPolicyDocument()
      The policy document.

    • setPolicyDocument

      @Stability(Stable) public void setPolicyDocument(@NotNull Object value)
      The policy document.

    • getPolicyName

      @Stability(Stable) @NotNull public String getPolicyName()
      The name of the policy document.

    • setPolicyName

      @Stability(Stable) public void setPolicyName(@NotNull String value)
      The name of the policy document.

    • getGroups

      @Stability(Stable) @Nullable public List<String> getGroups()
      The name of the group to associate the policy with.

    • setGroups

      @Stability(Stable) public void setGroups(@Nullable List<String> value)
      The name of the group to associate the policy with.

    • getRoles

      @Stability(Stable) @Nullable public List<String> getRoles()
      The name of the role to associate the policy with.

    • setRoles

      @Stability(Stable) public void setRoles(@Nullable List<String> value)
      The name of the role to associate the policy with.

    • getUsers

      @Stability(Stable) @Nullable public List<String> getUsers()
      The name of the user to associate the policy with.

    • setUsers

      @Stability(Stable) public void setUsers(@Nullable List<String> value)
      The name of the user to associate the policy with.