class Aws::Transfer::Types::ListedUser

Returns properties of the user that you specify.

@!attribute [rw] arn

Provides the unique Amazon Resource Name (ARN) for the user that you
want to learn about.
@return [String]

@!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.

<note markdown="1"> The IAM role that controls your users' access to your Amazon S3
bucket for servers with `Domain=S3`, or your EFS file system for
servers with `Domain=EFS`.

 The policies attached to this role determine the level of access you
want to provide your users when transferring files into and out of
your S3 buckets or EFS file systems.

 </note>
@return [String]

@!attribute [rw] ssh_public_key_count

Specifies the number of SSH public keys stored for the user you
specified.
@return [Integer]

@!attribute [rw] user_name

Specifies the name of the user whose ARN was specified. User names
are used for authentication purposes.
@return [String]

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

Constants

SENSITIVE