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 server using the client.
|
CreateUserRequest.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.
|
CreateUserRequest.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.
|
CreateUserRequest.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.
|
CreateUserRequest.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.
|
CreateUserRequest.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.
|
CreateUserRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateUserRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateUserRequest.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 CreateUserRequest.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 EFS file
systems. |
CreateUserRequest.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 EFS file
systems. |
CreateUserRequest.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.
|
CreateUserRequest.Builder |
serverId(String serverId)
A system-assigned unique identifier for a server instance.
|
CreateUserRequest.Builder |
sshPublicKeyBody(String sshPublicKeyBody)
The public portion of the Secure Shell (SSH) key used to authenticate the user to the 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
ServerId. |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateUserRequest.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.
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.
CreateUserRequest.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 EFS paths as
is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to
your users.
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
EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or
Amazon EFS paths visible to your users.HomeDirectoryType,
HomeDirectoryTypeCreateUserRequest.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 EFS paths as
is in their file transfer protocol clients. If you set it LOGICAL, you need to provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to
your users.
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
EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or
Amazon EFS paths visible to your users.HomeDirectoryType,
HomeDirectoryTypeCreateUserRequest.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 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 is displayed as is. You also must ensure that
your Identity and Access Management (IAM) role provides access to paths in Target. This value
can be set only when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session 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 value the user should see for their home directory when they log in.
The following is an Entry and Target pair example for chroot.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
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 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 is
displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides
access to paths in Target. This value can be set only when HomeDirectoryType
is set to LOGICAL.
The following is an Entry and Target pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session 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 value the user should see for their home directory
when they log in.
The following is an Entry and Target pair example for chroot.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
CreateUserRequest.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 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 is displayed as is. You also must ensure that
your Identity and Access Management (IAM) role provides access to paths in Target. This value
can be set only when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session 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 value the user should see for their home directory when they log in.
The following is an Entry and Target pair example for chroot.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
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 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 is
displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides
access to paths in Target. This value can be set only when HomeDirectoryType
is set to LOGICAL.
The following is an Entry and Target pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session 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 value the user should see for their home directory
when they log in.
The following is an Entry and Target pair example for chroot.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
CreateUserRequest.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 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 is displayed as is. You also must ensure that
your Identity and Access Management (IAM) role provides access to paths in Target. This value
can be set only when HomeDirectoryType is set to LOGICAL.
The following is an Entry and Target pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session 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 value the user should see for their home directory when they log in.
The following is an Entry and Target pair example for chroot.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
HomeDirectoryMapEntry.Builder avoiding the need to
create one manually via
HomeDirectoryMapEntry.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #homeDirectoryMappings(List.
homeDirectoryMappings - a consumer that will call methods on
HomeDirectoryMapEntry.Builder#homeDirectoryMappings(java.util.Collection) CreateUserRequest.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 Example session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
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 Example session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
CreateUserRequest.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 EFS file
systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of
access your users get when transferring files into and out of your Amazon EFS file systems.
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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS
determine the level of access your users get when transferring files into and out of your Amazon EFS
file systems.default CreateUserRequest.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 EFS file
systems. The POSIX permissions that are set on files and directories in Amazon EFS determine 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 via PosixProfile.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to posixProfile(PosixProfile).
posixProfile - a consumer that will call methods on PosixProfile.BuilderposixProfile(PosixProfile)CreateUserRequest.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.
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.CreateUserRequest.Builder serverId(String serverId)
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
serverId - A system-assigned unique identifier for a 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 server.
The three standard SSH public key format elements are <key type>,
<body base64>, and an optional <comment>, with spaces between each
element.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
For RSA keys, the key type is ssh-rsa.
For ED25519 keys, the key type is ssh-ed25519.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or
ecdsa-sha2-nistp521, depending on the size of the key you generated.
sshPublicKeyBody - The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
The three standard SSH public key format elements are <key type>,
<body base64>, and an optional <comment>, with spaces between
each element.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
For RSA keys, the key type is ssh-rsa.
For ED25519 keys, the key type is ssh-ed25519.
For ECDSA keys, the key type is either ecdsa-sha2-nistp256,
ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the
key you generated.
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 method that creates an instance of theTag.Builder avoiding the need to create one manually
via Tag.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #tags(List.
tags - a consumer that will call methods on
Tag.Builder#tags(java.util.Collection) CreateUserRequest.Builder userName(String userName)
A unique string that identifies a user and is associated with a 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.
userName - A unique string that identifies a user and is associated with a 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.CreateUserRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateUserRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.