Package software.amazon.awscdk.services.iam

Class CfnUserPolicy.Builder

java.lang.Object

software.amazon.awscdk.services.iam.CfnUserPolicy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPolicy>

Enclosing class:

CfnUserPolicy

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

A fluent builder for CfnUserPolicy.

Method Summary

Modifier and Type	Method	Description
CfnUserPolicy	build()
static CfnUserPolicy.Builder	create(software.constructs.Construct scope, String id)
CfnUserPolicy.Builder	policyDocument(Object policyDocument)	The policy document.
CfnUserPolicy.Builder	policyName(String policyName)	The name of the policy document.
CfnUserPolicy.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 CfnUserPolicy.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnUserPolicy.Builder.

policyName

@Stability(Stable)
public CfnUserPolicy.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 CfnUserPolicy.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

policyDocument

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

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

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

build

@Stability(Stable)
public CfnUserPolicy build()

Specified by:

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

Returns:

a newly built instance of CfnUserPolicy.