Class: Aws::Transfer::Types::DescribedUser

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

Overview

Returns properties of the user that you want to describe.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

Returns:

  • (String) 


613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end

#home_directory ⇒ String

This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is ‘/your s3 bucket name/home/username `.

Returns:

  • (String) 


613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end

#home_directory_mappings ⇒ Array<Types::HomeDirectoryMapEntry>

Logical directory mappings that you specified for what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the “‘Entry`” and “`Target`” pair, where `Entry` shows how the path is made visible and `Target` is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in `Target`.

In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (“chroot”). To do this, you can set ‘Entry` to ’/‘ and set `Target` to the HomeDirectory parameter value.

In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (“chroot”). To do this, you can set ‘Entry` to ’/‘ and set `Target` to the HomeDirectory parameter value.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end

#home_directory_type ⇒ String

The type of landing directory (folder) you mapped for your users’ to see when they log into the SFTP server. 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) 


613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end

#policy ⇒ String

Specifies the name of the policy in use for the described user.

Returns:

  • (String) 


613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end

#role ⇒ String

This property specifies the IAM role that controls your user’s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user’s transfer requests.

Returns:

  • (String) 


613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end

#ssh_public_keys ⇒ Array<Types::SshPublicKey>

This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

Returns:



613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end

#user_name ⇒ String

This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.

Returns:

  • (String) 


613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/aws-sdk-transfer/types.rb', line 613

class DescribedUser < Struct.new(
  :arn,
  :home_directory,
  :home_directory_mappings,
  :home_directory_type,
  :policy,
  :role,
  :ssh_public_keys,
  :tags,
  :user_name)
  include Aws::Structure
end