software.amazon.awssdk.services.transfer.model

Interface CreateUserRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateUserRequest

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

Method Summary

Modifier and Type	Method and Description
CreateUserRequest.Builder	homeDirectory(String homeDirectory) The landing directory (folder) for a user when they log in to the server using their SFTP client.
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	policy(String policy) A scope-down policy for your user so you can use the same IAM role across multiple users.
CreateUserRequest.Builder	role(String role) The IAM role that controls your user’s access to your Amazon S3 bucket.
CreateUserRequest.Builder	serverId(String serverId) A system-assigned unique identifier for an SFTP server instance.
CreateUserRequest.Builder	sshPublicKeyBody(String sshPublicKeyBody) The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.
CreateUserRequest.Builder	tags(Collection<Tag> tags) Key-value pairs that can be used to group and search for users.
CreateUserRequest.Builder	tags(Consumer<Tag.Builder>... tags) Key-value pairs that can be used to group and search for users.
CreateUserRequest.Builder	tags(Tag... tags) Key-value pairs that can be used to group and search for users.
CreateUserRequest.Builder	userName(String userName) A unique string that identifies a user and is associated with a server as specified by the ServerId.

Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.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

homeDirectory

CreateUserRequest.Builder homeDirectory(String homeDirectory)

The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is /home/username .

Parameters:

homeDirectory - The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is /home/username .

Returns:

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

policy

CreateUserRequest.Builder policy(String policy)

A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Parameters:

policy - A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables 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.

role

CreateUserRequest.Builder role(String role)

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

serverId

CreateUserRequest.Builder serverId(String serverId)

A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.

Parameters:

serverId - A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.

Returns:

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

sshPublicKeyBody

CreateUserRequest.Builder sshPublicKeyBody(String sshPublicKeyBody)

The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.

Parameters:

sshPublicKeyBody - The public portion of the Secure Shall (SSH) key used to authenticate the user to the SFTP server.

Returns:

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

tags

CreateUserRequest.Builder tags(Collection<Tag> tags)

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

Parameters:

tags - Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

Returns:

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

tags

CreateUserRequest.Builder tags(Tag... tags)

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

Parameters:

tags - Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

Returns:

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

tags

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

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

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

CreateUserRequest.Builder userName(String userName)

A unique string that identifies a user and is associated with a server as specified by the ServerId.

Parameters:

userName - A unique string that identifies a user and is associated with a server as specified by the ServerId.

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.