Package software.amazon.awscdk.services.iam

Interface CfnUserPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-26T23:01:06.972Z")
@Stability(Stable)
public interface CfnUserPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPolicy.

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;
 CfnUserPolicyProps cfnUserPolicyProps = CfnUserPolicyProps.builder()
         .policyName("policyName")
         .userName("userName")
         // the properties below are optional
         .policyDocument(policyDocument)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPolicyProps.Builder	builder()
default Object	getPolicyDocument()	The policy document.
String	getPolicyName()	The name of the policy document.
String	getUserName()	The name of the user to associate the policy with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyName

@Stability(Stable)
@NotNull
String getPolicyName()

The name of the policy document.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

See Also:

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

getUserName

@Stability(Stable)
@NotNull
String getUserName()

The name of the user to associate the policy with.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html#cfn-iam-userpolicy-username

getPolicyDocument

@Stability(Stable)
@Nullable
default Object getPolicyDocument()

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

• Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range
• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ )
• The special characters tab ( ), line feed ( ), and carriage return ( )

See Also:

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

builder

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

Returns:

a CfnUserPolicyProps.Builder of CfnUserPolicyProps