@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()
For responses, this returns true if the service returned a value for the HomeDirectoryMappings property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
homeDirectory()
The landing directory (folder) for a user when they log in to the server using the client.
|
List<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.
|
HomeDirectoryType |
homeDirectoryType()
The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
String |
homeDirectoryTypeAsString()
The type of landing directory (folder) you want your users' home directory to be when they log into the server.
|
String |
policy()
A session policy for your user so that you can use the same IAM role across multiple users.
|
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. |
String |
role()
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3
bucket or EFS file system.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateUserRequest.Builder> |
serializableBuilderClass() |
String |
serverId()
A system-assigned unique identifier for a server instance.
|
String |
sshPublicKeyBody()
The public portion of the Secure Shell (SSH) key used to authenticate the user to the 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
ServerId. |
overrideConfigurationcopypublic final 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.
A HomeDirectory example is /bucket_name/home/mydirectory.
public final HomeDirectoryType homeDirectoryType()
The type of landing directory (folder) you want your users' home directory to be when they log into 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 EFS 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 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 EFS paths
visible to your users.HomeDirectoryTypepublic final String homeDirectoryTypeAsString()
The type of landing directory (folder) you want your users' home directory to be when they log into 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 EFS 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 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 EFS paths
visible to your users.HomeDirectoryTypepublic final boolean hasHomeDirectoryMappings()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final List<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 Amazon Web
Services Identity and Access Management (IAM) role provides access to paths in Target. This value
can only be set 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 HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a
workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your
directory. If using the CLI, use the s3api or efsapi call instead of s3 or
efs 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasHomeDirectoryMappings() method.
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 Amazon Web Services Identity and Access Management (IAM)
role provides access to paths in Target. This value can only be set 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 HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
If the target of a logical directory entry does not exist in Amazon S3 or EFS, the entry is ignored. As a
workaround, you can use the Amazon S3 API or EFS API to create 0 byte objects as place holders for your
directory. If using the CLI, use the s3api or efsapi call instead of
s3 or efs 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 final String policy()
A session policy for your user so that 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}.
This only applies when the domain of ServerId is S3. EFS does not use session policies.
For session policies, Amazon Web Services 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.
${Transfer:UserName}, ${Transfer:HomeDirectory}, and
${Transfer:HomeBucket}.
This only applies when the domain of ServerId is S3. EFS does not use session policies.
For session policies, Amazon Web Services 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.
public final 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.
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.public final String role()
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.
public final String serverId()
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
public final String sshPublicKeyBody()
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
public final 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.
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.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 final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final 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 final String toString()
public final <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.