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)


4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4597

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

#home_directoryString

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.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

Returns:

  • (String)


4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4597

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

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 Amazon EFS path as is in their file transfer protocol clients. If you set it to 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.

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

Returns:

  • (String)


4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4597

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

#roleString

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.

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.

Returns:

  • (String)


4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4597

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)


4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4597

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)


4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4597

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