Table Of Contents


User Guide

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

[ aws . transfer ]



Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. The call returns the ServerId property assigned by the service to the newly created server. Reference this ServerId property when you make updates to your server, or work with users.

The response returns the ServerId value for the newly created server.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--endpoint-details <value>]
[--endpoint-type <value>]
[--identity-provider-details <value>]
[--identity-provider-type <value>]
[--logging-role <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--endpoint-details (structure)

Shorthand Syntax:


JSON Syntax:

  "VpcEndpointId": "string"

--endpoint-type (string)

Possible values:


--identity-provider-details (structure)

An array containing all of the information required to call a customer-supplied authentication API. This parameter is not required when the IdentityProviderType value of server that is created uses the SERVICE_MANAGED authentication method.

Shorthand Syntax:


JSON Syntax:

  "Url": "string",
  "InvocationRole": "string"

--identity-provider-type (string)

The mode of authentication enabled for this service. The default value is SERVICE_MANAGED , which allows you to store and access SFTP user credentials within the service. An IdentityProviderType value of API_GATEWAY indicates that user authentication requires a call to an API Gateway endpoint URL provided by you to integrate an identity provider of your choice.

Possible values:


--logging-role (string)

A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

--tags (list)

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

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

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


ServerId -> (string)

The service-assigned ID of the SFTP server that is created.