Class: Aws::Transfer::Types::CreateUserRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:

  • (String)


915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#home_directory_mappingsArray<Types::HomeDirectoryMapEntry>

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

The following is an Entry and Target pair example.

[ \{ "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" \} ]

In most cases, you can use this value instead of the session 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.

The following is an Entry and Target pair example for chroot.

[ \{ "Entry": "/", "Target": "/bucket_name/home/mydirectory" \} ]

Returns:



915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :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 EFS paths as is in their file transfer protocol clients. If you set it 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.

Returns:

  • (String)


915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#policyString

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include $\{Transfer:UserName\}, $\{Transfer:HomeDirectory\}, and $\{Transfer:HomeBucket\}.

This policy applies only when the domain of ServerId is Amazon S3. Amazon EFS does not use session policies.

For session policies, Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

For an example of a session policy, see Example session policy.

For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.

Returns:

  • (String)


915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#posix_profileTypes::PosixProfile

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

Returns:



915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :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.

Returns:

  • (String)


915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#server_idString

A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.

Returns:

  • (String)


915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#ssh_public_key_bodyString

The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.

Transfer Family accepts RSA, ECDSA, and ED25519 keys.

Returns:

  • (String)


915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

Returns:



915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

A unique string that identifies a user and is associated with a ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.

Returns:

  • (String)


915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 915

class CreateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :posix_profile,
  :role,
  :server_id,
  :ssh_public_key_body,
  :tags,
  :user_name)
  SENSITIVE = []
  include Aws::Structure
end