software.amazon.awscdk.services.iam

Class User.Builder

java.lang.Object

software.amazon.awscdk.services.iam.User.Builder

Enclosing class:

User

public static final class User.Builder
extends java.lang.Object

A fluent builder for User.

Method Summary

Modifier and Type	Method and Description
User	build()
static User.Builder	create(software.constructs.Construct scope, java.lang.String id)
User.Builder	groups(java.util.List<? extends IGroup> groups) Groups to add this user to.
User.Builder	managedPolicies(java.util.List<? extends IManagedPolicy> managedPolicies) A list of managed policies associated with this role.
User.Builder	password(SecretValue password) The password for the user.
User.Builder	passwordResetRequired(java.lang.Boolean passwordResetRequired) Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console.
User.Builder	path(java.lang.String path) The path for the user name.
User.Builder	permissionsBoundary(IManagedPolicy permissionsBoundary) AWS supports permissions boundaries for IAM entities (users or roles).
User.Builder	userName(java.lang.String userName) A name for the IAM user.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static User.Builder create(software.constructs.Construct scope,
                                  java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of User.Builder.

groups

public User.Builder groups(java.util.List<? extends IGroup> groups)

Groups to add this user to.

You can also use addToGroup to add this user to a group.

Default: - No groups.

Parameters:

groups - Groups to add this user to. This parameter is required.

Returns:

this

managedPolicies

public User.Builder managedPolicies(java.util.List<? extends IManagedPolicy> managedPolicies)

A list of managed policies associated with this role.

You can add managed policies later using addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).

Default: - No managed policies.

Parameters:

managedPolicies - A list of managed policies associated with this role. This parameter is required.

Returns:

this

password

public User.Builder password(SecretValue password)

The password for the user. This is required so the user can access the AWS Management Console.

You can use SecretValue.unsafePlainText to specify a password in plain text or use secretsmanager.Secret.fromSecretAttributes to reference a secret in Secrets Manager.

Default: - User won't be able to access the management console without a password.

Parameters:

password - The password for the user. This is required so the user can access the AWS Management Console. This parameter is required.

Returns:

this

passwordResetRequired

public User.Builder passwordResetRequired(java.lang.Boolean passwordResetRequired)

Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console.

If this is set to 'true', you must also specify "initialPassword".

Default: false

Parameters:

passwordResetRequired - Specifies whether the user is required to set a new password the next time the user logs in to the AWS Management Console. This parameter is required.

Returns:

this

path

public User.Builder path(java.lang.String path)

The path for the user name.

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

Default: /

Parameters:

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

Returns:

this

permissionsBoundary

public User.Builder permissionsBoundary(IManagedPolicy permissionsBoundary)

AWS supports permissions boundaries for IAM entities (users or roles).

A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.

Default: - No permissions boundary.

Parameters:

permissionsBoundary - AWS supports permissions boundaries for IAM entities (users or roles). This parameter is required.

Returns:

this

userName

public User.Builder userName(java.lang.String userName)

A name for the IAM user.

For valid values, see the UserName parameter for the CreateUser action in the IAM API Reference. 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 cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new 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.

Default: - Generated by CloudFormation (recommended)

Parameters:

userName - A name for the IAM user. This parameter is required.

Returns:

this

build

public User build()