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

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

Overview

Returns properties of the user that you specify.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1420

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

#home_directoryString

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)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1420

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

#home_directory_typeString

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.

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1420

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

#roleString

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.

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1420

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_countInteger

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

Returns:

  • (Integer)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1420

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

#user_nameString

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

Returns:

  • (String)


1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1420

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