Table Of Contents

Feedback

User Guide

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

[ aws . transfer ]

update-server

Description

Updates the server properties after that server has been created.

The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--endpoint-details (structure)

The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

Shorthand Syntax:

VpcEndpointId=string

JSON Syntax:

{
  "VpcEndpointId": "string"
}

--endpoint-type (string)

The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

Possible values:

  • PUBLIC
  • 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 SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

--identity-provider-details (structure)

This response parameter is 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)

A value that 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.

--server-id (string)

A system-assigned unique identifier for an SFTP 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 an SFTP server that the user account is assigned to.