software.amazon.awssdk.services.transfer.model

Interface DescribedUser.Builder

All Superinterfaces:

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

Enclosing class:

DescribedUser

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

Method Summary

Modifier and Type	Method and Description
DescribedUser.Builder	arn(String arn) This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.
DescribedUser.Builder	homeDirectory(String homeDirectory) This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user.
DescribedUser.Builder	policy(String policy) Specifies the name of the policy in use for the described user.
DescribedUser.Builder	role(String role) This property specifies the IAM role that controls your user’s access to your Amazon S3 bucket.
DescribedUser.Builder	sshPublicKeys(Collection<SshPublicKey> sshPublicKeys) This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
DescribedUser.Builder	sshPublicKeys(Consumer<SshPublicKey.Builder>... sshPublicKeys) This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
DescribedUser.Builder	sshPublicKeys(SshPublicKey... sshPublicKeys) This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.
DescribedUser.Builder	tags(Collection<Tag> tags) This property contains the key-value pairs for the user requested.
DescribedUser.Builder	tags(Consumer<Tag.Builder>... tags) This property contains the key-value pairs for the user requested.
DescribedUser.Builder	tags(Tag... tags) This property contains the key-value pairs for the user requested.
DescribedUser.Builder	userName(String userName) This property is the name of the user that was requested to be described.

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

arn

DescribedUser.Builder arn(String arn)

This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Parameters:

arn - This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Returns:

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

homeDirectory

DescribedUser.Builder homeDirectory(String homeDirectory)

This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: /bucket_name/home/username .

Parameters:

homeDirectory - This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: /bucket_name/home/username .

Returns:

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

policy

DescribedUser.Builder policy(String policy)

Specifies the name of the policy in use for the described user.

Parameters:

policy - Specifies the name of the policy in use for the described user.

Returns:

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

role

DescribedUser.Builder role(String role)

This property specifies the IAM role that controls your user’s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user’s transfer requests.

Parameters:

role - This property specifies the IAM role that controls your user’s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user’s transfer requests.

Returns:

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

sshPublicKeys

DescribedUser.Builder sshPublicKeys(Collection<SshPublicKey> sshPublicKeys)

This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

Parameters:

sshPublicKeys - This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

Returns:

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

sshPublicKeys

DescribedUser.Builder sshPublicKeys(SshPublicKey... sshPublicKeys)

This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

Parameters:

sshPublicKeys - This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

Returns:

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

sshPublicKeys

DescribedUser.Builder sshPublicKeys(Consumer<SshPublicKey.Builder>... sshPublicKeys)

This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

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 #sshPublicKeys(List).

Parameters:

sshPublicKeys - 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:

#sshPublicKeys(List)

tags

DescribedUser.Builder tags(Collection<Tag> tags)

This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Parameters:

tags - This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Returns:

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

tags

DescribedUser.Builder tags(Tag... tags)

This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Parameters:

tags - This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Returns:

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

tags

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

This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

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)

userName

DescribedUser.Builder userName(String userName)

This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.

Parameters:

userName - This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.

Returns:

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