@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateUserRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
CreateUserRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateUserRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getHomeDirectory()
The landing directory (folder) for a user when they log in to the server using the client.
|
List<HomeDirectoryMapEntry> |
getHomeDirectoryMappings()
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.
|
String |
getHomeDirectoryType()
The type of landing directory (folder) that you want your users' home directory to be when they log in to the
server.
|
String |
getPolicy()
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across
multiple users.
|
PosixProfile |
getPosixProfile()
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 |
getRole()
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.
|
String |
getServerId()
A system-assigned unique identifier for a server instance.
|
String |
getSshPublicKeyBody()
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
|
List<Tag> |
getTags()
Key-value pairs that can be used to group and search for users.
|
String |
getUserName()
A unique string that identifies a user and is associated with a
ServerId. |
int |
hashCode() |
void |
setHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
void |
setHomeDirectoryMappings(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.
|
void |
setHomeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) that you want your users' home directory to be when they log in to the
server.
|
void |
setPolicy(String policy)
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across
multiple users.
|
void |
setPosixProfile(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. |
void |
setRole(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.
|
void |
setServerId(String serverId)
A system-assigned unique identifier for a server instance.
|
void |
setSshPublicKeyBody(String sshPublicKeyBody)
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
|
void |
setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for users.
|
void |
setUserName(String userName)
A unique string that identifies a user and is associated with a
ServerId. |
String |
toString()
Returns a string representation of this object.
|
CreateUserRequest |
withHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
CreateUserRequest |
withHomeDirectoryMappings(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 |
withHomeDirectoryMappings(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 |
withHomeDirectoryType(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 |
withHomeDirectoryType(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 |
withPolicy(String policy)
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across
multiple users.
|
CreateUserRequest |
withPosixProfile(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 |
withRole(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 |
withServerId(String serverId)
A system-assigned unique identifier for a server instance.
|
CreateUserRequest |
withSshPublicKeyBody(String sshPublicKeyBody)
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
|
CreateUserRequest |
withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for users.
|
CreateUserRequest |
withTags(Tag... tags)
Key-value pairs that can be used to group and search for users.
|
CreateUserRequest |
withUserName(String userName)
A unique string that identifies a user and is associated with a
ServerId. |
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setHomeDirectory(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.
The HomeDirectory parameter is only used if HomeDirectoryType is set to
PATH.
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.
The HomeDirectory parameter is only used if HomeDirectoryType is set to
PATH.
public String getHomeDirectory()
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.
The HomeDirectory parameter is only used if HomeDirectoryType is set to
PATH.
A HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to
PATH.
public CreateUserRequest withHomeDirectory(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.
The HomeDirectory parameter is only used if HomeDirectoryType is set to
PATH.
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.
The HomeDirectory parameter is only used if HomeDirectoryType is set to
PATH.
public void setHomeDirectoryType(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 Amazon EFS path as
is in their file transfer protocol clients. If you set it to 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.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
both HomeDirectory and HomeDirectoryMappings in your template.
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 Amazon
EFS path as is in their file transfer protocol clients. If you set it to 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.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot
have both HomeDirectory and HomeDirectoryMappings in your template.
HomeDirectoryTypepublic String getHomeDirectoryType()
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 Amazon EFS path as
is in their file transfer protocol clients. If you set it to 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.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
both HomeDirectory and HomeDirectoryMappings in your template.
PATH, the user will see the absolute Amazon S3 bucket or Amazon
EFS path as is in their file transfer protocol clients. If you set it to 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.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You
cannot have both HomeDirectory and HomeDirectoryMappings in your template.
HomeDirectoryTypepublic CreateUserRequest withHomeDirectoryType(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 Amazon EFS path as
is in their file transfer protocol clients. If you set it to 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.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
both HomeDirectory and HomeDirectoryMappings in your template.
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 Amazon
EFS path as is in their file transfer protocol clients. If you set it to 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.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot
have both HomeDirectory and HomeDirectoryMappings in your template.
HomeDirectoryTypepublic CreateUserRequest withHomeDirectoryType(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 Amazon EFS path as
is in their file transfer protocol clients. If you set it to 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.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
both HomeDirectory and HomeDirectoryMappings in your template.
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 Amazon
EFS path as is in their file transfer protocol clients. If you set it to 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.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot
have both HomeDirectory and HomeDirectoryMappings in your template.
HomeDirectoryTypepublic List<HomeDirectoryMapEntry> getHomeDirectoryMappings()
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" } ]
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" } ]
public void setHomeDirectoryMappings(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" } ]
public CreateUserRequest withHomeDirectoryMappings(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" } ]
NOTE: This method appends the values to the existing list (if any). Use
setHomeDirectoryMappings(java.util.Collection) or
withHomeDirectoryMappings(java.util.Collection) if you want to override the existing values.
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" } ]
public CreateUserRequest withHomeDirectoryMappings(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" } ]
public void setPolicy(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.
public String getPolicy()
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.
${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.
public CreateUserRequest withPolicy(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.
public void setPosixProfile(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.public PosixProfile getPosixProfile()
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 CreateUserRequest withPosixProfile(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.public void setRole(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.public String getRole()
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.
public CreateUserRequest withRole(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.public void setServerId(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.public String getServerId()
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
public CreateUserRequest withServerId(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.public void setSshPublicKeyBody(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.
public String getSshPublicKeyBody()
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.
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.
public CreateUserRequest withSshPublicKeyBody(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.
public List<Tag> getTags()
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
public void setTags(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.public CreateUserRequest withTags(Tag... tags)
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
tags - Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for
any purpose.public CreateUserRequest withTags(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.public void setUserName(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.public String getUserName()
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 withUserName(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.public String toString()
toString in class ObjectObject.toString()public CreateUserRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()