software.amazon.awssdk.services.transfer.model

Class UpdateUserRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.transfer.model.TransferRequest

software.amazon.awssdk.services.transfer.model.UpdateUserRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateUserRequest
extends TransferRequest
implements ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateUserRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateUserRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	homeDirectory() The HomeDirectory parameter specifies the landing directory (folder) for a user when they log in to the server using their client.
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.
String	role() The IAM role that controls your user’s access to your Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateUserRequest.Builder>	serializableBuilderClass()
String	serverId() A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
UpdateUserRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userName() A unique string that identifies a user and is associated with a server as specified by the ServerId.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

homeDirectory

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

Returns:

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 .

policy

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

Returns:

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

role

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

Returns:

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.

serverId

public String serverId()

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

Returns:

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

userName

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

Returns:

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.

toBuilder

public UpdateUserRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

Specified by:

toBuilder in class TransferRequest

Returns:

a builder for type T

builder

public static UpdateUserRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateUserRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.