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) Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
DescribedUser.Builder	homeDirectory(String homeDirectory) The landing directory (folder) for a user when they log in to the server using the client.
DescribedUser.Builder	homeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings) Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible.
DescribedUser.Builder	homeDirectoryMappings(Consumer<HomeDirectoryMapEntry.Builder>... homeDirectoryMappings) Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible.
DescribedUser.Builder	homeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings) Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible.
DescribedUser.Builder	homeDirectoryType(HomeDirectoryType homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
DescribedUser.Builder	homeDirectoryType(String homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
DescribedUser.Builder	policy(String policy) A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users.
default DescribedUser.Builder	posixProfile(Consumer<PosixProfile.Builder> posixProfile) Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems.
DescribedUser.Builder	posixProfile(PosixProfile posixProfile) Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems.
DescribedUser.Builder	role(String role) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system.
DescribedUser.Builder	sshPublicKeys(Collection<SshPublicKey> sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
DescribedUser.Builder	sshPublicKeys(Consumer<SshPublicKey.Builder>... sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
DescribedUser.Builder	sshPublicKeys(SshPublicKey... sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
DescribedUser.Builder	tags(Collection<Tag> tags) Specifies the key-value pairs for the user requested.
DescribedUser.Builder	tags(Consumer<Tag.Builder>... tags) Specifies the key-value pairs for the user requested.
DescribedUser.Builder	tags(Tag... tags) Specifies the key-value pairs for the user requested.
DescribedUser.Builder	userName(String userName) Specifies the name of the user that was requested to be described.

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

DescribedUser.Builder arn(String arn)

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

Parameters:

arn - Specifies 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)

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Parameters:

homeDirectory - The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

Returns:

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

homeDirectoryMappings

DescribedUser.Builder homeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Parameters:

homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Returns:

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

homeDirectoryMappings

DescribedUser.Builder homeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Parameters:

homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

Returns:

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

homeDirectoryMappings

DescribedUser.Builder homeDirectoryMappings(Consumer<HomeDirectoryMapEntry.Builder>... homeDirectoryMappings)

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

This is a convenience method that creates an instance of the HomeDirectoryMapEntry.Builder avoiding the need to create one manually via HomeDirectoryMapEntry.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #homeDirectoryMappings(List).

Parameters:

homeDirectoryMappings - a consumer that will call methods on HomeDirectoryMapEntry.Builder

Returns:

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

See Also:

#homeDirectoryMappings(java.util.Collection)

homeDirectoryType

DescribedUser.Builder homeDirectoryType(String homeDirectoryType)

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

Parameters:

homeDirectoryType - The type of landing directory (folder) that you want your users' home directory to be when they log in to the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS 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

DescribedUser.Builder homeDirectoryType(HomeDirectoryType homeDirectoryType)

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

Parameters:

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

Returns:

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

See Also:

HomeDirectoryType, HomeDirectoryType

policy

DescribedUser.Builder policy(String policy)

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Parameters:

policy - A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Returns:

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

posixProfile

DescribedUser.Builder posixProfile(PosixProfile posixProfile)

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Parameters:

posixProfile - Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Returns:

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

posixProfile

default DescribedUser.Builder posixProfile(Consumer<PosixProfile.Builder> posixProfile)

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

This is a convenience method that creates an instance of the PosixProfile.Builder avoiding the need to create one manually via PosixProfile.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to posixProfile(PosixProfile).

Parameters:

posixProfile - a consumer that will call methods on PosixProfile.Builder

Returns:

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

See Also:

posixProfile(PosixProfile)

role

DescribedUser.Builder role(String role)

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Parameters:

role - The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or Amazon EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Returns:

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

sshPublicKeys

DescribedUser.Builder sshPublicKeys(Collection<SshPublicKey> sshPublicKeys)

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

Parameters:

sshPublicKeys - Specifies 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)

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

Parameters:

sshPublicKeys - Specifies 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)

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

This is a convenience method that creates an instance of the SshPublicKey.Builder avoiding the need to create one manually via SshPublicKey.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #sshPublicKeys(List).

Parameters:

sshPublicKeys - a consumer that will call methods on SshPublicKey.Builder

Returns:

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

See Also:

#sshPublicKeys(java.util.Collection)

tags

DescribedUser.Builder tags(Collection<Tag> tags)

Specifies 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 - Specifies 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)

Specifies 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 - Specifies 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)

Specifies 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 method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(java.util.Collection)

userName

DescribedUser.Builder userName(String userName)

Specifies 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 server.

Parameters:

userName - Specifies 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 server.

Returns:

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