UpdateServer
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.
Request Syntax
{
"Certificate": "string
",
"EndpointDetails": {
"AddressAllocationIds": [ "string
" ],
"SecurityGroupIds": [ "string
" ],
"SubnetIds": [ "string
" ],
"VpcEndpointId": "string
",
"VpcId": "string
"
},
"EndpointType": "string
",
"HostKey": "string
",
"IdentityProviderDetails": {
"DirectoryId": "string
",
"Function": "string
",
"InvocationRole": "string
",
"SftpAuthenticationMethods": "string
",
"Url": "string
"
},
"LoggingRole": "string
",
"PostAuthenticationLoginBanner": "string
",
"PreAuthenticationLoginBanner": "string
",
"ProtocolDetails": {
"As2Transports": [ "string
" ],
"PassiveIp": "string
",
"SetStatOption": "string
",
"TlsSessionResumptionMode": "string
"
},
"Protocols": [ "string
" ],
"S3StorageOptions": {
"DirectoryListingOptimization": "string
"
},
"SecurityPolicyName": "string
",
"ServerId": "string
",
"StructuredLogDestinations": [ "string
" ],
"WorkflowDetails": {
"OnPartialUpload": [
{
"ExecutionRole": "string
",
"WorkflowId": "string
"
}
],
"OnUpload": [
{
"ExecutionRole": "string
",
"WorkflowId": "string
"
}
]
}
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Certificate
-
The Amazon Resource Name (ARN) of the AmazonCertificate Manager (ACM) certificate. Required when
Protocols
is set toFTPS
.To request a new public certificate, see Request a public certificate in the AmazonCertificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the AmazonCertificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AmazonCertificate 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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1600.
Required: No
-
- EndpointDetails
-
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
Type: EndpointDetails object
Required: No
- EndpointType
-
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
Note
After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT
in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers withEndpointType=VPC_ENDPOINT
in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, useEndpointType
=VPC
.For more information, see Discontinuing the use of VPC_ENDPOINT.
It is recommended that you use
VPC
as theEndpointType
. 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 withEndpointType
set toVPC_ENDPOINT
.Type: String
Valid Values:
PUBLIC | VPC | VPC_ENDPOINT
Required: No
- HostKey
-
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.Use a minimum value of 2048 for the
-b
option. You can create a stronger key by using 3072 or 4096.Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.Valid values for the
-b
option for ECDSA are 256, 384, and 521.Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.For all of these commands, you can replace my-new-server-key with a string of your choice.
Important
If you aren't planning to migrate existing users from an existing SFTP-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 Update host keys for your SFTP-enabled server in the Amazon Transfer Family User Guide.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Required: No
- IdentityProviderDetails
-
An array containing all of the information required to call a customer's authentication API method.
Type: IdentityProviderDetails object
Required: No
- LoggingRole
-
The Amazon Resource Name (ARN) of the Amazon Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
(|arn:.*role/\S+)
Required: No
- PostAuthenticationLoginBanner
-
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
Note
The SFTP protocol does not support post-authentication display banners.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Pattern:
[\x09-\x0D\x20-\x7E]*
Required: No
- PreAuthenticationLoginBanner
-
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4096.
Pattern:
[\x09-\x0D\x20-\x7E]*
Required: No
- ProtocolDetails
-
The protocol settings that are configured for your server.
-
To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIp
parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. -
To ignore the error that is generated when the client attempts to use the
SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use theSetStatOption
parameter. To have the Amazon Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
call. -
To determine whether your Amazon Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
TlsSessionResumptionMode
parameter. -
As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Type: ProtocolDetails object
Required: No
-
- Protocols
-
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:
-
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH -
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption -
FTP
(File Transfer Protocol): Unencrypted file transfer -
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
Note
-
If you select
FTPS
, you must choose a certificate stored in Amazon Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. -
If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 4 items.
Valid Values:
SFTP | FTP | FTPS | AS2
Required: No
-
- S3StorageOptions
-
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a
TYPE
ofDIRECTORY
. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntry
Type
toFILE
if you want a mapping to have a file target.Type: S3StorageOptions object
Required: No
- SecurityPolicyName
-
Specifies the name of the security policy for the server.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 100.
Pattern:
Transfer[A-Za-z0-9]*SecurityPolicy-[A-Za-z0-9-]+
Required: No
- ServerId
-
A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
s-([0-9a-f]{17})
Required: Yes
- StructuredLogDestinations
-
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example,
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an
update-server
call. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 20. Maximum length of 1600.
Pattern:
arn:\S+
Required: No
- WorkflowDetails
-
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In addition to a workflow to execute when a file is uploaded completely,
WorkflowDetails
can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.To remove an associated workflow from a server, you can provide an empty
OnUpload
object, as in the following example.aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
Type: WorkflowDetails object
Required: No
Response Syntax
{
"ServerId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ServerId
-
A system-assigned unique identifier for a server that the Transfer Family user is assigned to.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
s-([0-9a-f]{17})
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 400
- ConflictException
-
This exception is thrown when the
UpdateServer
is called for a file transfer protocol-enabled server that has VPC as the endpoint type and the server'sVpcEndpointID
is not in the available state.HTTP Status Code: 400
- InternalServiceError
-
This exception is thrown when an error occurs in the Amazon Transfer Family service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
- ResourceExistsException
-
The requested resource does not exist, or exists in a region other than the one specified for the command.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when a resource is not found by the AmazonTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AmazonTransfer Family service is not available.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
Examples
Example
The following example updates the role of a server.
Sample Request
{
"EndpointDetails": {
"VpcEndpointId": "vpce-01234f056f3g13",
"LoggingRole": "CloudWatchS3Events",
"ServerId": "s-01234567890abcdef"
}
}
Example
The following example removes any associated workflows from the server.
Sample Request
aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
Example
This is a sample response for this API call.
Sample Response
{
"ServerId": "s-01234567890abcdef"
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: