Package software.amazon.awscdk.services.iam

Class CfnUser.Builder

java.lang.Object

software.amazon.awscdk.services.iam.CfnUser.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUser>

Enclosing class:

CfnUser

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

A fluent builder for CfnUser.

Method Summary

Modifier and Type	Method	Description
CfnUser	build()
static CfnUser.Builder	create(software.constructs.Construct scope, String id)
CfnUser.Builder	groups(List<String> groups)	A list of group names to which you want to add the user.
CfnUser.Builder	loginProfile(IResolvable loginProfile)	Creates a password for the specified IAM user.
CfnUser.Builder	loginProfile(CfnUser.LoginProfileProperty loginProfile)	Creates a password for the specified IAM user.
CfnUser.Builder	managedPolicyArns(List<String> managedPolicyArns)	A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
CfnUser.Builder	path(String path)	The path for the user name.
CfnUser.Builder	permissionsBoundary(String permissionsBoundary)	The ARN of the managed policy that is used to set the permissions boundary for the user.
CfnUser.Builder	policies(List<? extends Object> policies)	Adds or updates an inline policy document that is embedded in the specified IAM user.
CfnUser.Builder	policies(IResolvable policies)	Adds or updates an inline policy document that is embedded in the specified IAM user.
CfnUser.Builder	tags(List<? extends CfnTag> tags)	A list of tags that you want to attach to the new user.
CfnUser.Builder	userName(String userName)	The name of the user to create.

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 CfnUser.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 CfnUser.Builder.

groups

@Stability(Stable)
public CfnUser.Builder groups(List<String> groups)

A list of group names to which you want to add the user.

Parameters:

groups - A list of group names to which you want to add the user. This parameter is required.

Returns:

this

See Also:

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

loginProfile

@Stability(Stable)
public CfnUser.Builder loginProfile(IResolvable loginProfile)

Creates a password for the specified IAM user.

A password allows an IAM user to access AWS services through the AWS Management Console .

You can use the AWS CLI , the AWS API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the AWS Management Console .

For more information about managing passwords, see Managing passwords in the IAM User Guide .

Parameters:

loginProfile - Creates a password for the specified IAM user. This parameter is required.

Returns:

this

See Also:

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

loginProfile

@Stability(Stable)
public CfnUser.Builder loginProfile(CfnUser.LoginProfileProperty loginProfile)

Creates a password for the specified IAM user.

A password allows an IAM user to access AWS services through the AWS Management Console .

You can use the AWS CLI , the AWS API, or the Users page in the IAM console to create a password for any IAM user. Use ChangePassword to update your own existing password in the My Security Credentials page in the AWS Management Console .

For more information about managing passwords, see Managing passwords in the IAM User Guide .

Parameters:

loginProfile - Creates a password for the specified IAM user. This parameter is required.

Returns:

this

See Also:

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

managedPolicyArns

@Stability(Stable)
public CfnUser.Builder managedPolicyArns(List<String> managedPolicyArns)

A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .

Parameters:

managedPolicyArns - A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user. This parameter is required.

Returns:

this

See Also:

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

path

@Stability(Stable)
public CfnUser.Builder path(String path)

The path for the user name.

For more information about paths, see IAM identifiers in the IAM User Guide .

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern ) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( ! ) through the DEL character (  ), including most punctuation characters, digits, and upper and lowercased letters.

Parameters:

path - The path for the user name. This parameter is required.

Returns:

this

See Also:

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

permissionsBoundary

@Stability(Stable)
public CfnUser.Builder permissionsBoundary(String permissionsBoundary)

The ARN of the managed policy that is used to set the permissions boundary for the user.

A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see Permissions boundaries for IAM entities in the IAM User Guide .

For more information about policy types, see Policy types in the IAM User Guide .

Parameters:

permissionsBoundary - The ARN of the managed policy that is used to set the permissions boundary for the user. This parameter is required.

Returns:

this

See Also:

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

policies

@Stability(Stable)
public CfnUser.Builder policies(IResolvable policies)

Adds or updates an inline policy document that is embedded in the specified IAM user.

To view AWS::IAM::User snippets, see Declaring an IAM User Resource .

The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide .

Parameters:

policies - Adds or updates an inline policy document that is embedded in the specified IAM user. This parameter is required.

Returns:

this

See Also:

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

policies

@Stability(Stable)
public CfnUser.Builder policies(List<? extends Object> policies)

Adds or updates an inline policy document that is embedded in the specified IAM user.

To view AWS::IAM::User snippets, see Declaring an IAM User Resource .

The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.

For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide .

Parameters:

policies - Adds or updates an inline policy document that is embedded in the specified IAM user. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnUser.Builder tags(List<? extends CfnTag> tags)

A list of tags that you want to attach to the new user.

Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide .

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Parameters:

tags - A list of tags that you want to attach to the new user. This parameter is required.

Returns:

this

See Also:

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

userName

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

The name of the user to create. Do not include the path in this value.

This parameter allows (per 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: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the user name.

If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates .

Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using Fn::Join and AWS::Region to create a Region-specific name, as in the following example: {"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]} .

Parameters:

userName - The name of the user to create. Do not include the path in this value. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnUser build()

Specified by:

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

Returns:

a newly built instance of CfnUser.