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.

Synopsis¶

  update-server
[--certificate <value>]
[--endpoint-details <value>]
[--endpoint-type <value>]
[--host-key <value>]
[--identity-provider-details <value>]
[--logging-role <value>]
[--protocols <value>]
[--security-policy-name <value>]
--server-id <value>
[--cli-input-json | --cli-input-yaml]
[--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 .

To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide .

To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide .

To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide .

Certificates with the following cryptographic algorithms and key sizes are supported:

2048-bit RSA (RSA_2048)

4096-bit RSA (RSA_4096)

Elliptic Prime Curve 256 bit (EC_prime256v1)

Elliptic Prime Curve 384 bit (EC_secp384r1)

Elliptic Prime Curve 521 bit (EC_secp521r1)

Note

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

--endpoint-details (structure)

The virtual private cloud (VPC) endpoint settings that are configured for your 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.

AddressAllocationIds -> (list)

A list of address allocation IDs that are required to attach an Elastic IP address to your server’s endpoint.

Note

This property can only be set when EndpointType is set to VPC and it is only valid in the UpdateServer API.

(string)

SubnetIds -> (list)

A list of subnet IDs that are required to host your server endpoint in your VPC.

Note

This property can only be set when EndpointType is set to VPC .

(string)

VpcEndpointId -> (string)

The ID of the VPC endpoint.

Note

This property can only be set when EndpointType is set to VPC_ENDPOINT .

VpcId -> (string)

The VPC ID of the VPC in which a server’s endpoint will be hosted.

Note

This property can only be set when EndpointType is set to VPC .

SecurityGroupIds -> (list)

A list of security groups IDs that are available to attach to your server’s endpoint.

Note

This property can only be set when EndpointType is set to VPC .

You can only edit the SecurityGroupIds property in the UpdateServer API and only if you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to VPC .

(string)

Shorthand Syntax:

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

JSON Syntax:

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

--endpoint-type (string)

The type of endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.

Note

It is recommended that you use VPC as the EndpointType . With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server’s endpoint and use VPC security groups to restrict traffic by the client’s public IP address. This is not possible with EndpointType set to VPC_ENDPOINT .

Possible values:

PUBLIC

VPC

VPC_ENDPOINT

--host-key (string)

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

Warning

If you aren’t planning to migrate existing users from an existing 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 Change the host key for your SFTP-enabled 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.

Url -> (string)

Provides the location of the service endpoint used to authenticate users.

InvocationRole -> (string)

Provides the type of InvocationRole used to authenticate the user account.

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

Note

If you select FTPS , you must choose a certificate stored in AWS Certificate Manager (ACM) which will be used to identify your server when clients connect to it over FTPS.

If Protocol includes either FTP or FTPS , then the EndpointType must be VPC and the IdentityProviderType must be API_GATEWAY .

If Protocol includes FTP , then AddressAllocationIds cannot be associated.

If Protocol is set only to SFTP , the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED .

(string)

Syntax:

"string" "string" ...

Where valid values are:
  SFTP
  FTP
  FTPS

--security-policy-name (string)

Specifies the name of the security policy that is attached to the server.

--server-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 server that the user account is assigned to.

Table of Contents

Feedback

User Guide