Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data UpdateUser = UpdateUser' {}
- newUpdateUser :: Text -> Text -> UpdateUser
- updateUser_homeDirectory :: Lens' UpdateUser (Maybe Text)
- updateUser_homeDirectoryMappings :: Lens' UpdateUser (Maybe (NonEmpty HomeDirectoryMapEntry))
- updateUser_homeDirectoryType :: Lens' UpdateUser (Maybe HomeDirectoryType)
- updateUser_policy :: Lens' UpdateUser (Maybe Text)
- updateUser_posixProfile :: Lens' UpdateUser (Maybe PosixProfile)
- updateUser_role :: Lens' UpdateUser (Maybe Text)
- updateUser_serverId :: Lens' UpdateUser Text
- updateUser_userName :: Lens' UpdateUser Text
- data UpdateUserResponse = UpdateUserResponse' {}
- newUpdateUserResponse :: Int -> Text -> Text -> UpdateUserResponse
- updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int
- updateUserResponse_serverId :: Lens' UpdateUserResponse Text
- updateUserResponse_userName :: Lens' UpdateUserResponse Text
Creating a Request
data UpdateUser Source #
See: newUpdateUser
smart constructor.
UpdateUser' | |
|
Instances
Create a value of UpdateUser
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateUser
, updateUser_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
.
UpdateUser
, updateUser_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" } ]
UpdateUser
, updateUser_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.
UpdateUser
, updateUser_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.
UpdateUser
, updateUser_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.
UpdateUser
, updateUser_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.
UpdateUser
, updateUser_serverId
- A system-assigned unique identifier for a server instance that the user
account is assigned to.
UpdateUser
, updateUser_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.
Request Lenses
updateUser_homeDirectory :: Lens' UpdateUser (Maybe Text) Source #
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
.
updateUser_homeDirectoryMappings :: Lens' UpdateUser (Maybe (NonEmpty HomeDirectoryMapEntry)) Source #
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" } ]
updateUser_homeDirectoryType :: Lens' UpdateUser (Maybe HomeDirectoryType) Source #
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.
updateUser_policy :: Lens' UpdateUser (Maybe Text) Source #
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.
updateUser_posixProfile :: Lens' UpdateUser (Maybe PosixProfile) Source #
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.
updateUser_role :: Lens' UpdateUser (Maybe Text) Source #
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.
updateUser_serverId :: Lens' UpdateUser Text Source #
A system-assigned unique identifier for a server instance that the user account is assigned to.
updateUser_userName :: Lens' UpdateUser Text Source #
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.
Destructuring the Response
data UpdateUserResponse Source #
UpdateUserResponse
returns the user name and identifier for the
request to update a user's properties.
See: newUpdateUserResponse
smart constructor.
Instances
newUpdateUserResponse Source #
Create a value of UpdateUserResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateUserResponse'
, updateUserResponse_httpStatus
- The response's http status code.
UpdateUser
, updateUserResponse_serverId
- A system-assigned unique identifier for a server instance that the user
account is assigned to.
UpdateUser
, updateUserResponse_userName
- The unique identifier for a user that is assigned to a server instance
that was specified in the request.
Response Lenses
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #
The response's http status code.
updateUserResponse_serverId :: Lens' UpdateUserResponse Text Source #
A system-assigned unique identifier for a server instance that the user account is assigned to.
updateUserResponse_userName :: Lens' UpdateUserResponse Text Source #
The unique identifier for a user that is assigned to a server instance that was specified in the request.