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

Class CfnUserPolicyPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iam.CfnUserPolicyPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPolicyPropsMixin>

Enclosing class:

CfnUserPolicyPropsMixin

@Stability(Stable)
public static final class CfnUserPolicyPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPolicyPropsMixin>

A fluent builder for CfnUserPolicyPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnUserPolicyPropsMixin	build()
static CfnUserPolicyPropsMixin.Builder	create()
static CfnUserPolicyPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnUserPolicyPropsMixin.Builder	policyDocument(Object policyDocument)	The policy document.
CfnUserPolicyPropsMixin.Builder	policyName(String policyName)	The name of the policy document.
CfnUserPolicyPropsMixin.Builder	userName(String userName)	The name of the user to associate the policy with.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnUserPolicyPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnUserPolicyPropsMixin.Builder.

create

@Stability(Stable)
public static CfnUserPolicyPropsMixin.Builder create()

Returns:

a new instance of CfnUserPolicyPropsMixin.Builder.

policyDocument

@Stability(Stable)
public CfnUserPolicyPropsMixin.Builder policyDocument(Object policyDocument)

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 ( )

Parameters:

policyDocument - The policy document. This parameter is required.

Returns:

this

See Also:

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

policyName

@Stability(Stable)
public CfnUserPolicyPropsMixin.Builder policyName(String policyName)

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: _+=,.@-

Parameters:

policyName - The name of the policy document. This parameter is required.

Returns:

this

See Also:

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

userName

@Stability(Stable)
public CfnUserPolicyPropsMixin.Builder userName(String userName)

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: _+=,.@-

Parameters:

userName - The name of the user to associate the policy with. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUserPolicyPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPolicyPropsMixin>

Returns:

a newly built instance of CfnUserPolicyPropsMixin.