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

Inherits:

Struct

• Object
• Struct
• Aws::Transfer::Types::ListedUser

Includes:

Structure

Defined in:

lib/aws-sdk-transfer/types.rb

Overview

Returns properties of the user that you specify.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

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

• #home_directory ⇒ String

  The landing directory (folder) for a user when they log in to the server using the client.

• #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.

• #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.

• #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.

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 5166

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

<note markdown=“1”> The ‘HomeDirectory` parameter is only used if `HomeDirectoryType` is set to `PATH`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 5166

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

<note markdown=“1”> 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.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-transfer/types.rb', line 5166

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)

# File 'lib/aws-sdk-transfer/types.rb', line 5166

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)

# File 'lib/aws-sdk-transfer/types.rb', line 5166

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)

# File 'lib/aws-sdk-transfer/types.rb', line 5166

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