software.amazon.awssdk.services.transfer.model

Interface UpdateUserRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateUserRequest

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

Method Summary

Modifier and Type	Method and Description
UpdateUserRequest.Builder	homeDirectory(String homeDirectory) The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client.
UpdateUserRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
UpdateUserRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
UpdateUserRequest.Builder	policy(String policy) Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users.
UpdateUserRequest.Builder	role(String role) The IAM role that controls your user’s access to your Amazon S3 bucket.
UpdateUserRequest.Builder	serverId(String serverId) A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
UpdateUserRequest.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

UpdateUserRequest.Builder homeDirectory(String homeDirectory)

The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: /home/username .

Parameters:

homeDirectory - The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client. An example would be: /home/username .

Returns:

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

policy

UpdateUserRequest.Builder policy(String policy)

Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

Parameters:

policy - Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down users access to portions of your 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

UpdateUserRequest.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 Secure File Transfer Protocol (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 Secure File Transfer Protocol (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

UpdateUserRequest.Builder serverId(String serverId)

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Parameters:

serverId - A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Returns:

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

userName

UpdateUserRequest.Builder userName(String userName)

A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server.

Parameters:

userName - A unique string that identifies a user and is associated with a server as specified by the ServerId. 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.

overrideConfiguration

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

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