public static interface ListedAccess.Builder extends SdkPojo, CopyableBuilder<ListedAccess.Builder,ListedAccess>
| Modifier and Type | Method and Description |
|---|---|
ListedAccess.Builder |
externalId(String externalId)
A unique identifier that is required to identify specific groups within your directory.
|
ListedAccess.Builder |
homeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
ListedAccess.Builder |
homeDirectoryType(HomeDirectoryType homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the
server.
|
ListedAccess.Builder |
homeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the
server.
|
ListedAccess.Builder |
role(String role)
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3
bucket or EFS file system.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildListedAccess.Builder homeDirectory(String 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.
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.
ListedAccess.Builder homeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into 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 EFS paths visible to your
users.
homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into
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 EFS
paths visible to your users.HomeDirectoryType,
HomeDirectoryTypeListedAccess.Builder homeDirectoryType(HomeDirectoryType homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into 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 EFS paths visible to your
users.
homeDirectoryType - The type of landing directory (folder) you want your users' home directory to be when they log into
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 EFS
paths visible to your users.HomeDirectoryType,
HomeDirectoryTypeListedAccess.Builder role(String role)
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or 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 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.
role - Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your
Amazon S3 bucket or 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
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.Builder externalId(String 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 Amazon Web Services 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 regex 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: =,.@:/-
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 Amazon Web Services 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 regex 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: =,.@:/-
Copyright © 2022. All rights reserved.