Package software.amazon.awscdk.services.iam

Class CfnUserPolicy

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.CfnUserPolicy
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:08.130Z") @Stability(Stable) public class CfnUserPolicy extends CfnResource implements IInspectable
Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AWS::IAM::User . To create a new managed policy, use AWS::IAM::ManagedPolicy . For information about policies, see Managed policies and inline policies in the IAM User Guide .

For information about the maximum number of inline policies that you can embed in a user, see IAM and AWS STS quotas in the IAM User 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.iam.*;
 Object policyDocument;
 CfnUserPolicy cfnUserPolicy = CfnUserPolicy.Builder.create(this, "MyCfnUserPolicy")
         .policyName("policyName")
         .userName("userName")
         // the properties below are optional
         .policyDocument(policyDocument)
         .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

    • CfnUserPolicy

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

    • CfnUserPolicy

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

    • CfnUserPolicy

      @Stability(Stable) public CfnUserPolicy(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPolicyProps 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.

    • getCfnProperties

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

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

    • getUserName

      @Stability(Stable) @NotNull public String getUserName()
      The name of the user to associate the policy with.

    • setUserName

      @Stability(Stable) public void setUserName(@NotNull String value)
      The name of the user to associate the policy with.

    • getPolicyDocument

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

    • setPolicyDocument

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