Class: Aws::Transfer::Types::UpdateUserRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::UpdateUserRequest
- Defined in:
- gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#home_directory ⇒ String
The landing directory (folder) for a user when they log in to the server using the client.
-
#home_directory_mappings ⇒ Array<Types::HomeDirectoryMapEntry>
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.
-
#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.
-
#policy ⇒ String
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users.
-
#posix_profile ⇒ Types::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). -
#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.
-
#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 the
ServerId
.
Instance Attribute Details
#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
.
HomeDirectory
parameter is only used if HomeDirectoryType
is
set to PATH
.
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 6337 class UpdateUserRequest < Struct.new( :home_directory, :home_directory_type, :home_directory_mappings, :policy, :posix_profile, :role, :server_id, :user_name) SENSITIVE = [] include Aws::Structure end |
#home_directory_mappings ⇒ Array<Types::HomeDirectoryMapEntry>
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" \} ]
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 6337 class UpdateUserRequest < Struct.new( :home_directory, :home_directory_type, :home_directory_mappings, :policy, :posix_profile, :role, :server_id, :user_name) SENSITIVE = [] include Aws::Structure end |
#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 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.
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.
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 6337 class UpdateUserRequest < Struct.new( :home_directory, :home_directory_type, :home_directory_mappings, :policy, :posix_profile, :role, :server_id, :user_name) SENSITIVE = [] include Aws::Structure end |
#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\}
.
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.
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 6337 class UpdateUserRequest < Struct.new( :home_directory, :home_directory_type, :home_directory_mappings, :policy, :posix_profile, :role, :server_id, :user_name) SENSITIVE = [] include Aws::Structure end |
#posix_profile ⇒ Types::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.
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 6337 class UpdateUserRequest < Struct.new( :home_directory, :home_directory_type, :home_directory_mappings, :policy, :posix_profile, :role, :server_id, :user_name) SENSITIVE = [] include Aws::Structure end |
#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.
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 6337 class UpdateUserRequest < Struct.new( :home_directory, :home_directory_type, :home_directory_mappings, :policy, :posix_profile, :role, :server_id, :user_name) SENSITIVE = [] include Aws::Structure end |
#server_id ⇒ String
A system-assigned unique identifier for a Transfer Family server instance that the user is assigned to.
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 6337 class UpdateUserRequest < Struct.new( :home_directory, :home_directory_type, :home_directory_mappings, :policy, :posix_profile, :role, :server_id, :user_name) SENSITIVE = [] include Aws::Structure end |
#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.
6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 6337 class UpdateUserRequest < Struct.new( :home_directory, :home_directory_type, :home_directory_mappings, :policy, :posix_profile, :role, :server_id, :user_name) SENSITIVE = [] include Aws::Structure end |