software.amazon.awssdk.services.iam.model

Interface CreateUserRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>, IamRequest.Builder, SdkBuilder<CreateUserRequest.Builder,CreateUserRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateUserRequest

public static interface CreateUserRequest.Builder
extends IamRequest.Builder, SdkPojo, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>

Method Summary

Modifier and Type	Method and Description
CreateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateUserRequest.Builder	path(String path) The path for the user name.
CreateUserRequest.Builder	permissionsBoundary(String permissionsBoundary) The ARN of the policy that is used to set the permissions boundary for the user.
CreateUserRequest.Builder	tags(Collection<Tag> tags) A list of tags that you want to attach to the newly created user.
CreateUserRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of tags that you want to attach to the newly created user.
CreateUserRequest.Builder	tags(Tag... tags) A list of tags that you want to attach to the newly created user.
CreateUserRequest.Builder	userName(String userName) The name of the user to create.

Methods inherited from interface software.amazon.awssdk.services.iam.model.IamRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

path

CreateUserRequest.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 (per 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. 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 (per 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

userName

CreateUserRequest.Builder userName(String userName)

The name of the user to create.

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: _+=,.@-. User names are not distinguished by case. For example, you cannot create users named both "TESTUSER" and "testuser".

Parameters:

userName - The name of the user to create.

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: _+=,.@-. User names are not distinguished by case. For example, you cannot create users named both "TESTUSER" and "testuser".

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateUserRequest.Builder tags(Collection<Tag> tags)

A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

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

Parameters:

tags - A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateUserRequest.Builder tags(Tag... tags)

A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

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

Parameters:

tags - A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateUserRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

permissionsBoundary

CreateUserRequest.Builder permissionsBoundary(String permissionsBoundary)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.