@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateUserRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
UpdateUserRequest() |
| Modifier and Type | Method and Description |
|---|---|
UpdateUserRequest |
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 Elastic File
Systems (Amazon EFS). |
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 Transfer Family server instance that the user is assigned to.
|
String |
getUserName()
A unique string that identifies a user and is associated with a server as specified by the
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 Elastic File
Systems (Amazon EFS). |
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 Transfer Family server instance that the user is assigned to.
|
void |
setUserName(String userName)
A unique string that identifies a user and is associated with a server as specified by the
ServerId. |
String |
toString()
Returns a string representation of this object.
|
UpdateUserRequest |
withHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
UpdateUserRequest |
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.
|
UpdateUserRequest |
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.
|
UpdateUserRequest |
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.
|
UpdateUserRequest |
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.
|
UpdateUserRequest |
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.
|
UpdateUserRequest |
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 Elastic File
Systems (Amazon EFS). |
UpdateUserRequest |
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.
|
UpdateUserRequest |
withServerId(String serverId)
A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.
|
UpdateUserRequest |
withUserName(String userName)
A unique string that identifies a user and is associated with a server as specified by the
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.
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.
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.
A HomeDirectory example is /bucket_name/home/mydirectory.
public UpdateUserRequest 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.
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.
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 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.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 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.
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.HomeDirectoryTypepublic UpdateUserRequest 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 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.HomeDirectoryTypepublic UpdateUserRequest 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 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.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 down your user 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" } ]
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 down your user 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" } ]
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 down your user 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" } ]
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 down your user 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" } ]
public UpdateUserRequest 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 down your user 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" } ]
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 down your user 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" } ]
public UpdateUserRequest 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 down your user 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" } ]
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 down your user 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" } ]
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 Creating a 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 Creating a 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 Creating a 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 Creating a session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
public UpdateUserRequest 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 Creating a 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 Creating a 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 Elastic File
Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines
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
Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your
file system determines 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 Elastic File
Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines
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
Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your
file system determines the level of access your users get when transferring files into and out of your
Amazon EFS file systems.public UpdateUserRequest 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 Elastic File
Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines
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
Elastic File Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your
file system determines 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 UpdateUserRequest 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 Transfer Family server instance that the user is assigned to.
serverId - A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.public String getServerId()
A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.
public UpdateUserRequest withServerId(String serverId)
A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.
serverId - A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.public void setUserName(String userName)
A unique string that identifies a user and is associated with a 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, or at sign.
userName - A unique string that identifies a user and is associated with a 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, or at sign.public String getUserName()
A unique string that identifies a user and is associated with a 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, 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 UpdateUserRequest withUserName(String userName)
A unique string that identifies a user and is associated with a 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, or at sign.
userName - A unique string that identifies a user and is associated with a 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, or at sign.public String toString()
toString in class ObjectObject.toString()public UpdateUserRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()