software.amazon.awssdk.services.transfer.model

Interface ListedUser.Builder

All Superinterfaces:

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

Enclosing class:

ListedUser

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

Method Summary

Modifier and Type	Method and Description
ListedUser.Builder	arn(String arn) Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
ListedUser.Builder	homeDirectory(String homeDirectory) Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.
ListedUser.Builder	homeDirectoryType(HomeDirectoryType homeDirectoryType) Specifies the type of landing directory (folder) you mapped for your users' home directory.
ListedUser.Builder	homeDirectoryType(String homeDirectoryType) Specifies the type of landing directory (folder) you mapped for your users' home directory.
ListedUser.Builder	role(String role) Specifies the role that is in use by this user.
ListedUser.Builder	sshPublicKeyCount(Integer sshPublicKeyCount) Specifies the number of SSH public keys stored for the user you specified.
ListedUser.Builder	userName(String userName) Specifies the name of the user whose ARN was specified.

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

arn

ListedUser.Builder arn(String arn)

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

Parameters:

arn - Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

Returns:

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

homeDirectory

ListedUser.Builder homeDirectory(String homeDirectory)

Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

Parameters:

homeDirectory - Specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

Returns:

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

homeDirectoryType

ListedUser.Builder homeDirectoryType(String homeDirectoryType)

Specifies the type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Parameters:

homeDirectoryType - Specifies the type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Returns:

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

See Also:

HomeDirectoryType, HomeDirectoryType

homeDirectoryType

ListedUser.Builder homeDirectoryType(HomeDirectoryType homeDirectoryType)

Specifies the type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Parameters:

homeDirectoryType - Specifies the type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Returns:

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

See Also:

HomeDirectoryType, HomeDirectoryType

role

ListedUser.Builder role(String role)

Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

Parameters:

role - Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

Returns:

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

sshPublicKeyCount

ListedUser.Builder sshPublicKeyCount(Integer sshPublicKeyCount)

Specifies the number of SSH public keys stored for the user you specified.

Parameters:

sshPublicKeyCount - Specifies the number of SSH public keys stored for the user you specified.

Returns:

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

userName

ListedUser.Builder userName(String userName)

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

Parameters:

userName - Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

Returns:

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