Package software.amazon.awscdk.cfnpropertymixins.services.iam

Interface CfnUserPolicyMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPolicyMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.023Z")
@Stability(Stable)
public interface CfnUserPolicyMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnUserPolicyPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iam.*;
 Object policyDocument;
 CfnUserPolicyMixinProps cfnUserPolicyMixinProps = CfnUserPolicyMixinProps.builder()
         .policyDocument(policyDocument)
         .policyName("policyName")
         .userName("userName")
         .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	CfnUserPolicyMixinProps.Builder	A builder for CfnUserPolicyMixinProps
static final class	CfnUserPolicyMixinProps.Jsii$Proxy	An implementation for CfnUserPolicyMixinProps

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyDocument

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

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. 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

getPolicyName

@Stability(Stable)
@Nullable
default 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)
@Nullable
default 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

builder

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

Returns:

a CfnUserPolicyMixinProps.Builder of CfnUserPolicyMixinProps