Table Of Contents

Feedback

User Guide

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

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . transfer ]

update-server

Description

Updates the file transfer protocol-enabled server's properties after that server has been created.

The UpdateServer call returns the ServerId of the server you updated.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-server
[--certificate <value>]
[--endpoint-details <value>]
[--endpoint-type <value>]
[--host-key <value>]
[--identity-provider-details <value>]
[--logging-role <value>]
[--protocols <value>]
--server-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--certificate (string)

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS .

--endpoint-details (structure)

The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled server. With a VPC endpoint, you can restrict access to your server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Shorthand Syntax:

AddressAllocationIds=string,string,SubnetIds=string,string,VpcEndpointId=string,VpcId=string

JSON Syntax:

{
  "AddressAllocationIds": ["string", ...],
  "SubnetIds": ["string", ...],
  "VpcEndpointId": "string",
  "VpcId": "string"
}

--endpoint-type (string)

The type of endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, your server isn't accessible over the public internet.

Possible values:

  • PUBLIC
  • VPC
  • VPC_ENDPOINT

--host-key (string)

The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key .

Warning

If you aren't planning to migrate existing users from an existing file transfer protocol-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide .

--identity-provider-details (structure)

An array containing all of the information required to call a customer's authentication API method.

Shorthand Syntax:

Url=string,InvocationRole=string

JSON Syntax:

{
  "Url": "string",
  "InvocationRole": "string"
}

--logging-role (string)

Changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

--protocols (list)

Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:

  • Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
  • File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
  • File Transfer Protocol (FTP): Unencrypted file transfer

Syntax:

"string" "string" ...

Where valid values are:
  SFTP
  FTP
  FTPS

--server-id (string)

A system-assigned unique identifier for a file transfer protocol-enabled server instance that the user account is assigned to.

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

A system-assigned unique identifier for a file transfer protocol-enabled server that the user account is assigned to.