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 want to describe.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)

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

#home_directoryString

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 is your-Amazon-S3-bucket-name>/home/username .

Returns:

  • (String)

    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.

#home_directory_mappingsArray<Types::HomeDirectoryMapEntry>

Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target.

In most cases, you can use this value instead of the scope-down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to \'/\' and set Target to the HomeDirectory parameter value.

Returns:

  • (Array<Types::HomeDirectoryMapEntry>)

    Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible.

#home_directory_typeString

Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.

Possible values:

  • PATH
  • LOGICAL

Returns:

  • (String)

    Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server.

#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

Specifies the IAM role that controls your users\' 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 a file transfer protocol-enabled server to access your resources when servicing your users\' transfer requests.

Returns:

  • (String)

    Specifies the IAM role that controls your users\' access to your Amazon S3 bucket.

#ssh_public_keysArray<Types::SshPublicKey>

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

Returns:

  • (Array<Types::SshPublicKey>)

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

#tagsArray<Types::Tag>

Specifies 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>)

    Specifies the key-value pairs for the user requested.

#user_nameString

Specifies 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 file transfer protocol-enabled server.

Returns:

  • (String)

    Specifies the name of the user that was requested to be described.