@Generated(value="software.amazon.awssdk:codegen") public final class CreateUserRequest extends TransferRequest implements ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateUserRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateUserRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
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).
|
boolean |
hasTags()
Returns true if the Tags 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()
The landing directory (folder) for a user when they log in to the file transfer protocol-enabled server using the
client.
|
List<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.
|
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.
|
String |
homeDirectoryTypeAsString()
The type of landing directory (folder) you want your users' home directory to be when they log into the file
transfer protocol-enabled server.
|
String |
policy()
A scope-down policy for your user so you can use the same IAM role across multiple users.
|
String |
role()
The IAM role that controls your users' access to your Amazon S3 bucket.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateUserRequest.Builder> |
serializableBuilderClass() |
String |
serverId()
A system-assigned unique identifier for a file transfer protocol-enabled server instance.
|
String |
sshPublicKeyBody()
The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer
protocol-enabled server.
|
List<Tag> |
tags()
Key-value pairs that can be used to group and search for users.
|
CreateUserRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
String |
userName()
A unique string that identifies a user and is associated with a file transfer protocol-enabled server as
specified by the
ServerId. |
overrideConfigurationcopypublic 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 .
An example is your-Amazon-S3-bucket-name>/home/username .
public 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.
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().
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.HomeDirectoryTypepublic String homeDirectoryTypeAsString()
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.
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().
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.HomeDirectoryTypepublic boolean hasHomeDirectoryMappings()
public List<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.
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.
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.
public 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.
${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.
public 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.
public 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.
public String sshPublicKeyBody()
The public portion of the Secure Shell (SSH) key used to authenticate the user to the file transfer protocol-enabled server.
public boolean hasTags()
public List<Tag> tags()
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags() to see if a value was sent in this field.
public 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.
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.public CreateUserRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateUserRequest.Builder,CreateUserRequest>toBuilder in class TransferRequestpublic static CreateUserRequest.Builder builder()
public static Class<? extends CreateUserRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode in class AwsRequestpublic boolean equals(Object obj)
equals in class AwsRequestpublic boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.