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:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

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

Returns:

  • (String) 


1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/aws-sdk-transfer/types.rb', line 1099

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

#home_directory ⇒ 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.

Returns:

  • (String) 


1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/aws-sdk-transfer/types.rb', line 1099

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

#home_directory_type ⇒ String

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.

Returns:

  • (String) 


1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/aws-sdk-transfer/types.rb', line 1099

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

#role ⇒ String

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) 


1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/aws-sdk-transfer/types.rb', line 1099

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

#ssh_public_key_count ⇒ Integer

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

Returns:

  • (Integer) 


1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/aws-sdk-transfer/types.rb', line 1099

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

#user_name ⇒ String

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

Returns:

  • (String) 


1099
1100
1101
1102
1103
1104
1105
1106
1107
 
# File 'lib/aws-sdk-transfer/types.rb', line 1099

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