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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transfer/types.rb

Overview

Returns properties of the user that you specify.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) 

4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
 
# File 'lib/aws-sdk-transfer/types.rb', line 4152

class ListedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_type,
  :role,
  :ssh_public_key_count,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#home_directory ⇒ String

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`.

Returns:

  • (String) 

4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
 
# File 'lib/aws-sdk-transfer/types.rb', line 4152

class ListedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_type,
  :role,
  :ssh_public_key_count,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#home_directory_type ⇒ String

The type of landing directory (folder) that you want your users' home directory to be when they log in to 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 Amazon EFS paths visible to your users.

Returns:

  • (String) 

4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
 
# File 'lib/aws-sdk-transfer/types.rb', line 4152

class ListedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_type,
  :role,
  :ssh_public_key_count,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#role ⇒ String

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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>

Returns:

  • (String) 

4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
 
# File 'lib/aws-sdk-transfer/types.rb', line 4152

class ListedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_type,
  :role,
  :ssh_public_key_count,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#ssh_public_key_count ⇒ Integer

Specifies the number of SSH public keys stored for the user you specified.

Returns:

  • (Integer) 

4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
 
# File 'lib/aws-sdk-transfer/types.rb', line 4152

class ListedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_type,
  :role,
  :ssh_public_key_count,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#user_name ⇒ String

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

Returns:

  • (String) 

4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
 
# File 'lib/aws-sdk-transfer/types.rb', line 4152

class ListedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_type,
  :role,
  :ssh_public_key_count,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end