You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateUserRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  home_directory: "HomeDirectory",
  home_directory_type: "PATH", # accepts PATH, LOGICAL
  home_directory_mappings: [
    {
      entry: "MapEntry", # required
      target: "MapTarget", # required
    },
  ],
  policy: "Policy",
  role: "Role", # required
  server_id: "ServerId", # required
  ssh_public_key_body: "SshPublicKeyBody",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  user_name: "UserName", # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#home_directoryString

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

An example is <your-Amazon-S3-bucket-name>/home/username.

Returns:

  • (String)

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

#home_directory_mappingsArray<Types::HomeDirectoryMapEntry>

Logical directory mappings that specify 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. The following is an example.

'[ "/bucket2/documentation", { "Entry": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/$`{transfer:UserName}`.pdf" } ]'

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:

  • (Array<Types::HomeDirectoryMapEntry>)

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible.

#home_directory_typeString

The type of landing directory (folder) you want your users\' home directory to be 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.

Possible values:

  • PATH
  • LOGICAL

Returns:

  • (String)

    The type of landing directory (folder) you want your users\' home directory to be when they log into the SFTP server.

#policyString

A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include $`{Transfer:UserName}`, $`{Transfer:HomeDirectory}`, and $`{Transfer:HomeBucket}`.

For scope-down policies, AWS Transfer for SFTP 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 scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down%22&gt;Creating a Scope-Down Policy.

For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html%22 in the AWS Security Token Service API Reference.

Returns:

  • (String)

    A scope-down policy for your user so you can use the same IAM role across multiple users.

#roleString

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)

    The IAM role that controls your user\'s access to your Amazon S3 bucket.

#server_idString

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

Returns:

  • (String)

    A system-assigned unique identifier for an SFTP server instance.

#ssh_public_key_bodyString

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

Returns:

  • (String)

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

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

  • (Array<Types::Tag>)

    Key-value pairs that can be used to group and search for users.

#user_nameString

A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can\'t start with a hyphen.

Returns:

  • (String)

    A unique string that identifies a user and is associated with a server as specified by the ServerId.