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

Class: Aws::Transfer::Types::DescribedUser

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

Overview

Returns properties of the user that you wish to describe.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Returns:

  • (String)

    This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

#home_directoryString

This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example would be: /bucket_name/home/username .

Returns:

  • (String)

    This property specifies the landing directory (or folder) which is the location that files are written to or read from in an Amazon S3 bucket for the described user.

#policyString

Specifies the name of the policy in use for the described user.

Returns:

  • (String)

    Specifies the name of the policy in use for the described user.

#roleString

This property specifies the IAM role that controls your user\'s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user\'s transfer requests.

Returns:

  • (String)

    This property specifies the IAM role that controls your user\'s access to your Amazon S3 bucket.

#ssh_public_keysArray<Types::SshPublicKey>

This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

Returns:

  • (Array<Types::SshPublicKey>)

    This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

#tagsArray<Types::Tag>

This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Returns:

  • (Array<Types::Tag>)

    This property contains the key-value pairs for the user requested.

#user_nameString

This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.

Returns:

  • (String)

    This property is the name of the user that was requested to be described.