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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description UpdateUserRequest.Builder
homeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.UpdateUserRequest.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.UpdateUserRequest.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.UpdateUserRequest.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.UpdateUserRequest.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.UpdateUserRequest.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.UpdateUserRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdateUserRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdateUserRequest.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 UpdateUserRequest.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 Systems (Amazon EFS).UpdateUserRequest.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 Systems (Amazon EFS).UpdateUserRequest.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.UpdateUserRequest.Builder
serverId(String serverId)
A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.UpdateUserRequest.Builder
userName(String userName)
A unique string that identifies a user and is associated with a server as specified by theServerId
.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder
build
-
-
-
-
Method Detail
-
homeDirectory
UpdateUserRequest.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
.The
HomeDirectory
parameter is only used ifHomeDirectoryType
is set toPATH
.- 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
.The
HomeDirectory
parameter is only used ifHomeDirectoryType
is set toPATH
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectoryType
UpdateUserRequest.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 Amazon EFS path as is in their file transfer protocol clients. If you set it toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.- 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 toPATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HomeDirectoryType
,HomeDirectoryType
-
homeDirectoryType
UpdateUserRequest.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 Amazon EFS path as is in their file transfer protocol clients. If you set it toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.- 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 toPATH
, the user will see the absolute Amazon S3 bucket or Amazon EFS path as is in their file transfer protocol clients. If you set it toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
HomeDirectoryType
,HomeDirectoryType
-
homeDirectoryMappings
UpdateUserRequest.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
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.The following is an
Entry
andTarget
pair example.[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("
chroot
"). To do this, you can setEntry
to '/' and setTarget
to the HomeDirectory parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
- 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 theEntry
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.The following is an
Entry
andTarget
pair example.[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("
chroot
"). To do this, you can setEntry
to '/' and setTarget
to the HomeDirectory parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectoryMappings
UpdateUserRequest.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
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.The following is an
Entry
andTarget
pair example.[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("
chroot
"). To do this, you can setEntry
to '/' and setTarget
to the HomeDirectory parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
- 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 theEntry
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.The following is an
Entry
andTarget
pair example.[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("
chroot
"). To do this, you can setEntry
to '/' and setTarget
to the HomeDirectory parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectoryMappings
UpdateUserRequest.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
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.The following is an
Entry
andTarget
pair example.[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("
chroot
"). To do this, you can setEntry
to '/' and setTarget
to the HomeDirectory parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
HomeDirectoryMapEntry.Builder
avoiding the need to create one manually viaHomeDirectoryMapEntry.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 onHomeDirectoryMapEntry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#homeDirectoryMappings(java.util.Collection
)
-
policy
UpdateUserRequest.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}
.This policy applies only when the domain of
ServerId
is Amazon S3. Amazon EFS does not use session policies.For session policies, 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 session policy, see Creating a session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
- 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}
.This policy applies only when the domain of
ServerId
is Amazon S3. Amazon EFS does not use session policies.For session policies, 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 session policy, see Creating a session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
posixProfile
UpdateUserRequest.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 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.- 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 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:
- Returns a reference to this object so that method calls can be chained together.
-
posixProfile
default UpdateUserRequest.Builder posixProfile(Consumer<PosixProfile.Builder> posixProfile)
Specifies the full POSIX identity, including user ID (
This is a convenience method that creates an instance of theUid
), 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.PosixProfile.Builder
avoiding the need to create one manually viaPosixProfile.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toposixProfile(PosixProfile)
.- Parameters:
posixProfile
- a consumer that will call methods onPosixProfile.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
posixProfile(PosixProfile)
-
role
UpdateUserRequest.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.
-
serverId
UpdateUserRequest.Builder serverId(String serverId)
A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.
- Parameters:
serverId
- A system-assigned unique identifier for a Transfer Family server instance that the user 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 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.- Parameters:
userName
- A unique string that identifies a user and is associated with a server as specified by theServerId
. 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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
UpdateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-