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 |
Synopsis
- data ListedUser = ListedUser' {}
- newListedUser :: Text -> ListedUser
- listedUser_homeDirectory :: Lens' ListedUser (Maybe Text)
- listedUser_homeDirectoryType :: Lens' ListedUser (Maybe HomeDirectoryType)
- listedUser_role :: Lens' ListedUser (Maybe Text)
- listedUser_sshPublicKeyCount :: Lens' ListedUser (Maybe Int)
- listedUser_userName :: Lens' ListedUser (Maybe Text)
- listedUser_arn :: Lens' ListedUser Text
Documentation
data ListedUser Source #
Returns properties of the user that you specify.
See: newListedUser
smart constructor.
ListedUser' | |
|
Instances
Create a value of ListedUser
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:homeDirectory:ListedUser'
, listedUser_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
.
$sel:homeDirectoryType:ListedUser'
, listedUser_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.
$sel:role':ListedUser'
, listedUser_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.
The IAM role that controls your users' access to your Amazon S3 bucket
for servers with Domain=S3
, or your EFS file system for servers with
Domain=EFS
.
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
$sel:sshPublicKeyCount:ListedUser'
, listedUser_sshPublicKeyCount
- Specifies the number of SSH public keys stored for the user you
specified.
$sel:userName:ListedUser'
, listedUser_userName
- Specifies the name of the user whose ARN was specified. User names are
used for authentication purposes.
$sel:arn:ListedUser'
, listedUser_arn
- Provides the unique Amazon Resource Name (ARN) for the user that you
want to learn about.
listedUser_homeDirectory :: Lens' ListedUser (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
.
listedUser_homeDirectoryType :: Lens' ListedUser (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.
listedUser_role :: Lens' ListedUser (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.
The IAM role that controls your users' access to your Amazon S3 bucket
for servers with Domain=S3
, or your EFS file system for servers with
Domain=EFS
.
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
listedUser_sshPublicKeyCount :: Lens' ListedUser (Maybe Int) Source #
Specifies the number of SSH public keys stored for the user you specified.
listedUser_userName :: Lens' ListedUser (Maybe Text) Source #
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
listedUser_arn :: Lens' ListedUser Text Source #
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.