public static interface CreateUserRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateUserRequest.Builder |
homeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using
the client.
|
CreateUserRequest.Builder |
homeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)
Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how
you want to make them visible.
|
CreateUserRequest.Builder |
homeDirectoryMappings(Consumer<HomeDirectoryMapEntry.Builder>... homeDirectoryMappings)
Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how
you want to make them visible.
|
CreateUserRequest.Builder |
homeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)
Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how
you want to make them visible.
|
CreateUserRequest.Builder |
homeDirectoryType(HomeDirectoryType homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the file
transfer protocol-enabled server.
|
CreateUserRequest.Builder |
homeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the file
transfer protocol-enabled server.
|
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 users' access to your Amazon S3 bucket.
|
CreateUserRequest.Builder |
serverId(String serverId)
A system-assigned unique identifier for a file transfer protocol-enabled server instance.
|
CreateUserRequest.Builder |
sshPublicKeyBody(String sshPublicKeyBody)
The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer
protocol-enabled 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 file transfer protocol-enabled server as
specified by the
ServerId. |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateUserRequest.Builder homeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using the client.
An example is your-Amazon-S3-bucket-name>/home/username .
homeDirectory - The landing directory (folder) for a user when they log in to the file transfer protocol-enabled
server using the client.
An example is your-Amazon-S3-bucket-name>/home/username .
CreateUserRequest.Builder homeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the file
transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon
S3 bucket 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 paths
visible to your users.
homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into
the file transfer protocol-enabled server. If you set it to PATH, the user will see the
absolute Amazon S3 bucket 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 paths visible to your users.HomeDirectoryType,
HomeDirectoryTypeCreateUserRequest.Builder homeDirectoryType(HomeDirectoryType homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the file
transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon
S3 bucket 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 paths
visible to your users.
homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into
the file transfer protocol-enabled server. If you set it to PATH, the user will see the
absolute Amazon S3 bucket 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 paths visible to your users.HomeDirectoryType,
HomeDirectoryTypeCreateUserRequest.Builder homeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)
Logical directory mappings that specify what Amazon S3 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 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 your user down 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, the entry will be ignored. As a
workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If
using the CLI, use the s3api call instead of s3 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.
homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 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 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 your user down 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, the entry will be ignored. As
a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your
directory. If using the CLI, use the s3api call instead of s3 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.
CreateUserRequest.Builder homeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)
Logical directory mappings that specify what Amazon S3 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 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 your user down 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, the entry will be ignored. As a
workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If
using the CLI, use the s3api call instead of s3 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.
homeDirectoryMappings - Logical directory mappings that specify what Amazon S3 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 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 your user down 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, the entry will be ignored. As
a workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your
directory. If using the CLI, use the s3api call instead of s3 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.
CreateUserRequest.Builder homeDirectoryMappings(Consumer<HomeDirectoryMapEntry.Builder>... homeDirectoryMappings)
Logical directory mappings that specify what Amazon S3 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 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 your user down 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, the entry will be ignored. As a
workaround, you can use the Amazon S3 API to create 0 byte objects as place holders for your directory. If
using the CLI, use the s3api call instead of s3 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.
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 #homeDirectoryMappings(List) .homeDirectoryMappings - a consumer that will call methods on List.Builder #homeDirectoryMappings(List) 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 that 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.
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 that 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.
CreateUserRequest.Builder role(String role)
The IAM role that controls your users' 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 file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
role - The IAM role that controls your users' 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 file transfer protocol-enabled server to access your resources when servicing your
users' transfer requests.CreateUserRequest.Builder serverId(String serverId)
A system-assigned unique identifier for a file transfer protocol-enabled server instance. This is the specific server that you added your user to.
serverId - A system-assigned unique identifier for a file transfer protocol-enabled server instance. This is the
specific server that you added your user to.CreateUserRequest.Builder sshPublicKeyBody(String sshPublicKeyBody)
The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer protocol-enabled server.
sshPublicKeyBody - The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer
protocol-enabled server.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.
tags - Key-value pairs that can be used to group and search for users. Tags are metadata attached to users
for any purpose.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.
tags - Key-value pairs that can be used to group and search for users. Tags are metadata attached to users
for any purpose.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 theList.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) .tags - a consumer that will call methods on List.Builder #tags(List) CreateUserRequest.Builder userName(String userName)
A unique string that identifies a user and is associated with a file transfer protocol-enabled 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, and at sign.
userName - A unique string that identifies a user and is associated with a file transfer protocol-enabled 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, and at sign.CreateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.CreateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.