class Aws::Transfer::Types::ListedAccess

Lists the properties for one or more specified associated accesses.

@!attribute [rw] home_directory

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`.
@return [String]

@!attribute [rw] home_directory_type

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.
@return [String]

@!attribute [rw] 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.
@return [String]

@!attribute [rw] external_id

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: =,.@:/-
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/transfer-2018-11-05/ListedAccess AWS API Documentation

Constants

SENSITIVE