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 ListedAccess = ListedAccess' {}
- newListedAccess :: ListedAccess
- listedAccess_externalId :: Lens' ListedAccess (Maybe Text)
- listedAccess_homeDirectory :: Lens' ListedAccess (Maybe Text)
- listedAccess_homeDirectoryType :: Lens' ListedAccess (Maybe HomeDirectoryType)
- listedAccess_role :: Lens' ListedAccess (Maybe Text)
Documentation
data ListedAccess Source #
Lists the properties for one or more specified associated accesses.
See: newListedAccess
smart constructor.
ListedAccess' | |
|
Instances
newListedAccess :: ListedAccess Source #
Create a value of ListedAccess
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:externalId:ListedAccess'
, listedAccess_externalId
- A unique identifier that is required to identify specific groups within
your directory. The users of the group that you associate have access to
your Amazon S3 or Amazon EFS resources over the enabled protocols using
Transfer Family. If you know the group name, you can view the SID values
by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "
YourGroupName
*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
$sel:homeDirectory:ListedAccess'
, listedAccess_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:ListedAccess'
, listedAccess_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':ListedAccess'
, listedAccess_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.
listedAccess_externalId :: Lens' ListedAccess (Maybe Text) Source #
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "
YourGroupName
*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
listedAccess_homeDirectory :: Lens' ListedAccess (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
.
listedAccess_homeDirectoryType :: Lens' ListedAccess (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.
listedAccess_role :: Lens' ListedAccess (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.