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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHomeDirectoryMappings() Returns true if the HomeDirectoryMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	homeDirectory() Specifies the landing directory (folder) for a user when they log in to the server using their file transfer protocol client.
List<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.
HomeDirectoryType	homeDirectoryType() The type of landing directory (folder) you want your users' home directory to be when they log into the server.
String	homeDirectoryTypeAsString() The type of landing directory (folder) you want your users' home directory to be when they log into the server.
String	policy() Allows you to supply a scope-down policy for your user so you can use the same IAM role across multiple users.
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 Systems (Amazon EFS).
String	role() The IAM role that controls your users' access to your Amazon S3 bucket.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateUserRequest.Builder>	serializableBuilderClass()
String	serverId() A system-assigned unique identifier for a server instance that the user account is assigned to.
UpdateUserRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

homeDirectory

public final String homeDirectory()

Specifies the landing directory (folder) for a user when they log in to the server using their file transfer protocol client.

An example is your-Amazon-S3-bucket-name>/home/username.

Returns:

Specifies the landing directory (folder) for a user when they log in to the server using their file transfer protocol client.

An example is your-Amazon-S3-bucket-name>/home/username.

homeDirectoryType

public final HomeDirectoryType homeDirectoryType()

The type of landing directory (folder) you want your users' home directory to be when they log into 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 will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

If the service returns an enum value that is not available in the current SDK version, homeDirectoryType will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from homeDirectoryTypeAsString().

Returns:

The type of landing directory (folder) you want your users' home directory to be when they log into 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 will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

See Also:

HomeDirectoryType

homeDirectoryTypeAsString

public final String homeDirectoryTypeAsString()

The type of landing directory (folder) you want your users' home directory to be when they log into 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 will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

If the service returns an enum value that is not available in the current SDK version, homeDirectoryType will return HomeDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from homeDirectoryTypeAsString().

Returns:

The type of landing directory (folder) you want your users' home directory to be when they log into 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 will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.

See Also:

HomeDirectoryType

hasHomeDirectoryMappings

public final boolean hasHomeDirectoryMappings()

Returns true if the HomeDirectoryMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

homeDirectoryMappings

public final List<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 will need to 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 will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.

'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

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

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your directory. If using the AWS CLI, use the s3api or efsapi call instead of s3 efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasHomeDirectoryMappings() to see if a value was sent in this field.

Returns:

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 will need to 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 will be displayed as is. You will need to also make sure that your IAM role provides access to paths in Target. The following is an example.

'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]'

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

If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry will be ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your directory. If using the AWS CLI, use the s3api or efsapi call instead of s3 efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.

policy

public final String policy()

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

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Creating a scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

Returns:

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

For scope-down policies, AWS Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a scope-down policy, see Creating a scope-down policy.

For more information, see AssumeRole in the AWS Security Token Service API Reference.

posixProfile

public final 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 Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Returns:

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 Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines the level of access your users get when transferring files into and out of your Amazon EFS file systems.

role

public final String role()

The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

Returns:

The IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

serverId

public final String serverId()

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

Returns:

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

userName

public final String userName()

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

Returns:

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

toBuilder

public UpdateUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateUserRequest.Builder,UpdateUserRequest>

Specified by:

toBuilder in class TransferRequest

builder

public static UpdateUserRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo