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 DescribedAccess = DescribedAccess' {}
- newDescribedAccess :: DescribedAccess
- describedAccess_externalId :: Lens' DescribedAccess (Maybe Text)
- describedAccess_homeDirectory :: Lens' DescribedAccess (Maybe Text)
- describedAccess_homeDirectoryMappings :: Lens' DescribedAccess (Maybe (NonEmpty HomeDirectoryMapEntry))
- describedAccess_homeDirectoryType :: Lens' DescribedAccess (Maybe HomeDirectoryType)
- describedAccess_policy :: Lens' DescribedAccess (Maybe Text)
- describedAccess_posixProfile :: Lens' DescribedAccess (Maybe PosixProfile)
- describedAccess_role :: Lens' DescribedAccess (Maybe Text)
Documentation
data DescribedAccess Source #
Describes the properties of the access that was specified.
See: newDescribedAccess
smart constructor.
DescribedAccess' | |
|
Instances
newDescribedAccess :: DescribedAccess Source #
Create a value of DescribedAccess
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:DescribedAccess'
, describedAccess_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:DescribedAccess'
, describedAccess_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:homeDirectoryMappings:DescribedAccess'
, describedAccess_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.
In most cases, you can use this value instead of the session policy to
lock down the associated access to the designated home directory
("chroot
"). To do this, you can set Entry
to '/' and set
Target
to the HomeDirectory
parameter value.
$sel:homeDirectoryType:DescribedAccess'
, describedAccess_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:policy:DescribedAccess'
, describedAccess_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}
.
$sel:posixProfile:DescribedAccess'
, describedAccess_posixProfile
- Undocumented member.
$sel:role':DescribedAccess'
, describedAccess_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.
describedAccess_externalId :: Lens' DescribedAccess (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: =,.@:/-
describedAccess_homeDirectory :: Lens' DescribedAccess (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
.
describedAccess_homeDirectoryMappings :: Lens' DescribedAccess (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.
In most cases, you can use this value instead of the session policy to
lock down the associated access to the designated home directory
("chroot
"). To do this, you can set Entry
to '/' and set
Target
to the HomeDirectory
parameter value.
describedAccess_homeDirectoryType :: Lens' DescribedAccess (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.
describedAccess_policy :: Lens' DescribedAccess (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}
.
describedAccess_posixProfile :: Lens' DescribedAccess (Maybe PosixProfile) Source #
Undocumented member.
describedAccess_role :: Lens' DescribedAccess (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.