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 |
Used by administrators to choose which groups in the directory should
have access to upload and download files over the enabled protocols
using Transfer Family. For example, a Microsoft Active Directory might
contain 50,000 users, but only a small fraction might need the ability
to transfer files to the server. An administrator can use CreateAccess
to limit the access to the correct set of users who need this ability.
Synopsis
- data CreateAccess = CreateAccess' {}
- newCreateAccess :: Text -> Text -> Text -> CreateAccess
- createAccess_homeDirectory :: Lens' CreateAccess (Maybe Text)
- createAccess_homeDirectoryMappings :: Lens' CreateAccess (Maybe (NonEmpty HomeDirectoryMapEntry))
- createAccess_homeDirectoryType :: Lens' CreateAccess (Maybe HomeDirectoryType)
- createAccess_policy :: Lens' CreateAccess (Maybe Text)
- createAccess_posixProfile :: Lens' CreateAccess (Maybe PosixProfile)
- createAccess_role :: Lens' CreateAccess Text
- createAccess_serverId :: Lens' CreateAccess Text
- createAccess_externalId :: Lens' CreateAccess Text
- data CreateAccessResponse = CreateAccessResponse' {
- httpStatus :: Int
- serverId :: Text
- externalId :: Text
- newCreateAccessResponse :: Int -> Text -> Text -> CreateAccessResponse
- createAccessResponse_httpStatus :: Lens' CreateAccessResponse Int
- createAccessResponse_serverId :: Lens' CreateAccessResponse Text
- createAccessResponse_externalId :: Lens' CreateAccessResponse Text
Creating a Request
data CreateAccess Source #
See: newCreateAccess
smart constructor.
CreateAccess' | |
|
Instances
Create a value of CreateAccess
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:
CreateAccess
, createAccess_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
.
CreateAccess
, createAccess_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" } ]
CreateAccess
, createAccess_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.
CreateAccess
, createAccess_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 Example session policy.
For more information, see AssumeRole in the Security Token Service API Reference.
CreateAccess
, createAccess_posixProfile
- Undocumented member.
CreateAccess
, createAccess_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.
CreateAccess
, createAccess_serverId
- A system-assigned unique identifier for a server instance. This is the
specific server that you added your user to.
CreateAccess
, createAccess_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: =,.@:/-
Request Lenses
createAccess_homeDirectory :: Lens' CreateAccess (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
.
createAccess_homeDirectoryMappings :: Lens' CreateAccess (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" } ]
createAccess_homeDirectoryType :: Lens' CreateAccess (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.
createAccess_policy :: Lens' CreateAccess (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 Example session policy.
For more information, see AssumeRole in the Security Token Service API Reference.
createAccess_posixProfile :: Lens' CreateAccess (Maybe PosixProfile) Source #
Undocumented member.
createAccess_role :: Lens' CreateAccess 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.
createAccess_serverId :: Lens' CreateAccess Text Source #
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
createAccess_externalId :: Lens' CreateAccess 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: =,.@:/-
Destructuring the Response
data CreateAccessResponse Source #
See: newCreateAccessResponse
smart constructor.
CreateAccessResponse' | |
|
Instances
newCreateAccessResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> CreateAccessResponse |
Create a value of CreateAccessResponse
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:CreateAccessResponse'
, createAccessResponse_httpStatus
- The response's http status code.
CreateAccess
, createAccessResponse_serverId
- The identifier of the server that the user is attached to.
CreateAccess
, createAccessResponse_externalId
- The external identifier of the group whose users have access to your
Amazon S3 or Amazon EFS resources over the enabled protocols using
Transfer Family.
Response Lenses
createAccessResponse_httpStatus :: Lens' CreateAccessResponse Int Source #
The response's http status code.
createAccessResponse_serverId :: Lens' CreateAccessResponse Text Source #
The identifier of the server that the user is attached to.
createAccessResponse_externalId :: Lens' CreateAccessResponse Text Source #
The external identifier of the group whose users have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family.