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
- Struct
- Aws::Transfer::Types::ListedUser
- Defined in:
- (unknown)
Overview
Returns properties of the user that you specify.
Instance Attribute Summary collapse
-
#arn ⇒ String
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
-
#home_directory ⇒ String
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_type ⇒ String
Specifies the type of landing directory (folder) you mapped for your users\' home directory.
-
#role ⇒ String
Specifies the role that is in use by this user.
-
#ssh_public_key_count ⇒ Integer
Specifies the number of SSH public keys stored for the user you specified.
-
#user_name ⇒ String
Specifies the name of the user whose ARN was specified.
Instance Attribute Details
#arn ⇒ String
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
#home_directory ⇒ String
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_type ⇒ String
Specifies 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 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
#role ⇒ String
Specifies the role that is in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows a file transfer protocol-enabled 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.
#ssh_public_key_count ⇒ Integer
Specifies the number of SSH public keys stored for the user you specified.
#user_name ⇒ String
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.