You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Transfer::Types::ListedUser

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returns properties of the user that you specify.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.

Returns:

  • (String)

    This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.

#home_directoryString

This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

Returns:

  • (String)

    This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

#home_directory_typeString

The type of landing directory (folder) you mapped for your users\' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

Possible values:

  • PATH
  • LOGICAL

Returns:

  • (String)

    The type of landing directory (folder) you mapped for your users\' home directory.

#roleString

The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user\'s behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

Returns:

  • (String)

    The role in use by this user.

#ssh_public_key_countInteger

This value is the number of SSH public keys stored for the user you specified.

Returns:

  • (Integer)

    This value is the number of SSH public keys stored for the user you specified.

#user_nameString

The name of the user whose ARN was specified. User names are used for authentication purposes.

Returns:

  • (String)

    The name of the user whose ARN was specified.