| Package | Description |
|---|---|
| software.amazon.awssdk.services.transfer |
Transfer Family is a fully managed service that enables the transfer of files over the File Transfer Protocol (FTP),
File Transfer Protocol over SSL (FTPS), or Secure Shell (SSH) File Transfer Protocol (SFTP) directly into and out of
Amazon Simple Storage Service (Amazon S3) or Amazon EFS.
|
| software.amazon.awssdk.services.transfer.model |
| Modifier and Type | Method and Description |
|---|---|
default CreateUserResponse |
TransferClient.createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
default CompletableFuture<CreateUserResponse> |
TransferAsyncClient.createUser(Consumer<CreateUserRequest.Builder> createUserRequest)
Creates a user and associates them with an existing file transfer protocol-enabled server.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateUserRequest.Builder |
CreateUserRequest.builder() |
CreateUserRequest.Builder |
CreateUserRequest.Builder.homeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
CreateUserRequest.Builder |
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 |
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 |
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 |
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 |
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 |
CreateUserRequest.Builder.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateUserRequest.Builder |
CreateUserRequest.Builder.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateUserRequest.Builder |
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 |
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 |
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 |
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 |
CreateUserRequest.Builder.serverId(String serverId)
A system-assigned unique identifier for a server instance.
|
CreateUserRequest.Builder |
CreateUserRequest.Builder.sshPublicKeyBody(String sshPublicKeyBody)
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
|
CreateUserRequest.Builder |
CreateUserRequest.Builder.tags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for users.
|
CreateUserRequest.Builder |
CreateUserRequest.Builder.tags(Consumer<Tag.Builder>... tags)
Key-value pairs that can be used to group and search for users.
|
CreateUserRequest.Builder |
CreateUserRequest.Builder.tags(Tag... tags)
Key-value pairs that can be used to group and search for users.
|
CreateUserRequest.Builder |
CreateUserRequest.toBuilder() |
CreateUserRequest.Builder |
CreateUserRequest.Builder.userName(String userName)
A unique string that identifies a user and is associated with a
ServerId. |
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends CreateUserRequest.Builder> |
CreateUserRequest.serializableBuilderClass() |
Copyright © 2023. All rights reserved.