software.amazon.awssdk.services.iam.model

Interface User.Builder

All Superinterfaces:

Buildable, CopyableBuilder<User.Builder,User>, SdkBuilder<User.Builder,User>, SdkPojo

Enclosing class:

User

public static interface User.Builder
extends SdkPojo, CopyableBuilder<User.Builder,User>

Method Summary

Modifier and Type	Method and Description
User.Builder	arn(String arn) The Amazon Resource Name (ARN) that identifies the user.
User.Builder	createDate(Instant createDate) The date and time, in ISO 8601 date-time format, when the user was created.
User.Builder	passwordLastUsed(Instant passwordLastUsed) The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website.
User.Builder	path(String path) The path to the user.
User.Builder	permissionsBoundary(AttachedPermissionsBoundary permissionsBoundary) The ARN of the policy used to set the permissions boundary for the user.
default User.Builder	permissionsBoundary(Consumer<AttachedPermissionsBoundary.Builder> permissionsBoundary) The ARN of the policy used to set the permissions boundary for the user.
User.Builder	tags(Collection<Tag> tags) A list of tags that are associated with the specified user.
User.Builder	tags(Consumer<Tag.Builder>... tags) A list of tags that are associated with the specified user.
User.Builder	tags(Tag... tags) A list of tags that are associated with the specified user.
User.Builder	userId(String userId) The stable and unique string identifying the user.
User.Builder	userName(String userName) The friendly name identifying the user.

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

equalsBySdkFields, 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

User.Builder path(String path)

The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Parameters:

path - The path to the user. For more information about paths, see IAM Identifiers in the IAM User Guide.

Returns:

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

userName

User.Builder userName(String userName)

The friendly name identifying the user.

Parameters:

userName - The friendly name identifying the user.

Returns:

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

userId

User.Builder userId(String userId)

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Parameters:

userId - The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

Returns:

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

arn

User.Builder arn(String arn)

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Parameters:

arn - The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.

Returns:

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

createDate

User.Builder createDate(Instant createDate)

The date and time, in ISO 8601 date-time format, when the user was created.

Parameters:

createDate - The date and time, in ISO 8601 date-time format, when the user was created.

Returns:

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

passwordLastUsed

User.Builder passwordLastUsed(Instant passwordLastUsed)

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

• The user never had a password.

• A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

Parameters:

passwordLastUsed - The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the IAM User Guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

• The user never had a password.

• A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

Returns:

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

permissionsBoundary

User.Builder permissionsBoundary(AttachedPermissionsBoundary permissionsBoundary)

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

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Parameters:

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

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

Returns:

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

permissionsBoundary

default User.Builder permissionsBoundary(Consumer<AttachedPermissionsBoundary.Builder> permissionsBoundary)

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

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

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

Parameters:

permissionsBoundary - a consumer that will call methods on AttachedPermissionsBoundary.Builder

Returns:

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

See Also:

permissionsBoundary(AttachedPermissionsBoundary)

tags

User.Builder tags(Collection<Tag> tags)

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Parameters:

tags - A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Returns:

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

tags

User.Builder tags(Tag... tags)

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Parameters:

tags - A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

Returns:

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

tags

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

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

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)