Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . transfer ]

create-user

Description

Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP) server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED . Using parameters for CreateUser , you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-user
[--home-directory <value>]
[--policy <value>]
--role <value>
--server-id <value>
[--ssh-public-key-body <value>]
[--tags <value>]
--user-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--home-directory (string)

The landing directory (folder) for a user when they log in to the server using their SFTP client. An example is ``/home/username `` .

--policy (string)

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

Note

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"Creating a Scope-Down Policy.

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

--role (string)

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.

--server-id (string)

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

--ssh-public-key-body (string)

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

--tags (list)

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

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--user-name (string)

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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ServerId -> (string)

The ID of the SFTP server that the user is attached to.

UserName -> (string)

A unique string that identifies a user account associated with an SFTP server.