AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName
and ServerId
you specify.
The response returns the ServerId
and the UserName
for the updated user.
In the console, you can select Restricted when you create or update a user. This ensures that the user can't access anything outside of their home directory. The programmatic way to configure this behavior is to update the user. Set their HomeDirectoryType
to LOGICAL
, and specify HomeDirectoryMappings
with Entry
as root (/
) and Target
as their home directory.
For example, if the user's home directory is /test/admin-user
, the following command updates the user so that their configuration in the console shows the Restricted flag as selected.
aws transfer update-user --server-id <server-id> --user-name admin-user --home-directory-type LOGICAL --home-directory-mappings "[{\"Entry\":\"/\", \"Target\":\"/test/admin-user\"}]"
See also: AWS API Documentation
update-user
[--home-directory <value>]
[--home-directory-type <value>]
[--home-directory-mappings <value>]
[--policy <value>]
[--posix-profile <value>]
[--role <value>]
--server-id <value>
--user-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--home-directory
(string)
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
.Note
TheHomeDirectory
parameter is only used ifHomeDirectoryType
is set toPATH
.
--home-directory-type
(string)
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 toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.Note
IfHomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.Possible values:
PATH
LOGICAL
--home-directory-mappings
(list)
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
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL .The following is an
Entry
andTarget
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 setEntry
to '/' and setTarget
to the HomeDirectory parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
(structure)
Represents an object that contains entries and targets for
HomeDirectoryMappings
.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
Entry -> (string)
Represents an entry forHomeDirectoryMappings
.Target -> (string)
Represents the map target that is used in aHomeDirectoryMapEntry
.Type -> (string)
Specifies the type of mapping. Set the type to
FILE
if you want the mapping to point to a file, orDIRECTORY
for the directory to point to a directory.Note
By default, home directory mappings have aType
ofDIRECTORY
when you create a Transfer Family server. You would need to explicitly setType
toFILE
if you want a mapping to have a file target.
Shorthand Syntax:
Entry=string,Target=string,Type=string ...
JSON Syntax:
[
{
"Entry": "string",
"Target": "string",
"Type": "FILE"|"DIRECTORY"
}
...
]
--policy
(string)
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}
.Note
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 .
--posix-profile
(structure)
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 -> (long)
The POSIX user ID used for all EFS operations by this user.Gid -> (long)
The POSIX group ID used for all EFS operations by this user.SecondaryGids -> (list)
The secondary POSIX group IDs used for all EFS operations by this user.
(long)
Shorthand Syntax:
Uid=long,Gid=long,SecondaryGids=long,long
JSON Syntax:
{
"Uid": long,
"Gid": long,
"SecondaryGids": [long, ...]
}
--role
(string)
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.
--server-id
(string)
A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.
--user-name
(string)
A unique string that identifies a user and is associated with a server as specified by theServerId
. 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.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
ServerId -> (string)
A system-assigned unique identifier for a Transfer Family server instance that the account is assigned to.
UserName -> (string)
The unique identifier for a user that is assigned to a server instance that was specified in the request.