You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Transfer::Types::UpdateUserRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::UpdateUserRequest
- Defined in:
- (unknown)
Overview
When passing UpdateUserRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
home_directory: "HomeDirectory",
home_directory_type: "PATH", # accepts PATH, LOGICAL
home_directory_mappings: [
{
entry: "MapEntry", # required
target: "MapTarget", # required
},
],
policy: "Policy",
role: "Role",
server_id: "ServerId", # required
user_name: "UserName", # required
}
Instance Attribute Summary collapse
-
#home_directory ⇒ String
Specifies the landing directory (folder) for a user when they log in to the server using their file transfer protocol client.
-
#home_directory_mappings ⇒ Array<Types::HomeDirectoryMapEntry>
Logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.
-
#home_directory_type ⇒ String
The type of landing directory (folder) you want your users\' home directory to be when they log into the server.
-
#policy ⇒ String
Allows you to supply a scope-down policy for your user so you can use the same IAM role across multiple users.
-
#role ⇒ String
The IAM role that controls your users\' access to your Amazon S3 bucket.
-
#server_id ⇒ String
A system-assigned unique identifier for a server instance that the user account is assigned to.
-
#user_name ⇒ String
A unique string that identifies a user and is associated with a server as specified by the
ServerId
.
Instance Attribute Details
#home_directory ⇒ String
Specifies the landing directory (folder) for a user when they log in to the server using their file transfer protocol client.
An example is your-Amazon-S3-bucket-name>/home/username
.
#home_directory_mappings ⇒ Array<Types::HomeDirectoryMapEntry>
Logical directory mappings that specify what Amazon S3 paths and keys
should be visible to your user and how you want to make them visible.
You will need to specify the \"Entry
\" and \"Target
\" pair, where
Entry
shows how the path is made visible and Target
is the actual
Amazon S3 path. If you only specify a target, it will be displayed as
is. You will need to also make sure that your IAM role provides access
to paths in Target
. The following is an example.
'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf",
"Target": "/bucket3/customized-reports/$`{transfer:UserName}`.pdf" } ]'
In most cases, you can use this value instead of the scope-down policy
to lock your user down to the designated home directory (\"chroot\"). To
do this, you can set Entry
to \'/\' and set Target
to the
HomeDirectory parameter value.
s3api
call instead of s3
so you can use the
put-object operation. For example, you use the following: aws s3api
put-object --bucket bucketname --key path/to/folder/
. Make sure that
the end of the key name ends in a / for it to be considered a folder.
#home_directory_type ⇒ String
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 paths as is in their
file transfer protocol clients. If you set it LOGICAL
, you will need
to provide mappings in the HomeDirectoryMappings
for how you want to
make Amazon S3 paths visible to your users.
Possible values:
- PATH
- LOGICAL
#policy ⇒ String
Allows you to supply a scope-down policy for your user so you can use
the same IAM role across multiple users. The policy scopes down user
access to portions of your Amazon S3 bucket. Variables you can use
inside this policy include $`{Transfer:UserName}`
,
$`{Transfer:HomeDirectory}`
, and $`{Transfer:HomeBucket}`
.
Policy
argument.
For an example of a scope-down policy, see Creating a scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
#role ⇒ String
The IAM role that controls your users\' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users\' transfer requests.
#server_id ⇒ String
A system-assigned unique identifier for a server instance that the user account is assigned to.
#user_name ⇒ String
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.