public static interface UpdateServerRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<UpdateServerRequest.Builder,UpdateServerRequest>
| Modifier and Type | Method and Description |
|---|---|
UpdateServerRequest.Builder |
certificate(String certificate)
The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate.
|
default UpdateServerRequest.Builder |
endpointDetails(Consumer<EndpointDetails.Builder> endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
UpdateServerRequest.Builder |
endpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
UpdateServerRequest.Builder |
endpointType(EndpointType endpointType)
The type of endpoint that you want your server to use.
|
UpdateServerRequest.Builder |
endpointType(String endpointType)
The type of endpoint that you want your server to use.
|
UpdateServerRequest.Builder |
hostKey(String hostKey)
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
|
default UpdateServerRequest.Builder |
identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)
An array containing all of the information required to call a customer's authentication API method.
|
UpdateServerRequest.Builder |
identityProviderDetails(IdentityProviderDetails identityProviderDetails)
An array containing all of the information required to call a customer's authentication API method.
|
UpdateServerRequest.Builder |
loggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
|
UpdateServerRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
UpdateServerRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
UpdateServerRequest.Builder |
postAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
UpdateServerRequest.Builder |
preAuthenticationLoginBanner(String preAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
default UpdateServerRequest.Builder |
protocolDetails(Consumer<ProtocolDetails.Builder> protocolDetails)
The protocol settings that are configured for your server.
|
UpdateServerRequest.Builder |
protocolDetails(ProtocolDetails protocolDetails)
The protocol settings that are configured for your server.
|
UpdateServerRequest.Builder |
protocols(Collection<Protocol> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
UpdateServerRequest.Builder |
protocols(Protocol... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
UpdateServerRequest.Builder |
protocolsWithStrings(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
UpdateServerRequest.Builder |
protocolsWithStrings(String... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
UpdateServerRequest.Builder |
securityPolicyName(String securityPolicyName)
Specifies the name of the security policy that is attached to the server.
|
UpdateServerRequest.Builder |
serverId(String serverId)
A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
|
UpdateServerRequest.Builder |
structuredLogDestinations(Collection<String> structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
UpdateServerRequest.Builder |
structuredLogDestinations(String... structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
default UpdateServerRequest.Builder |
workflowDetails(Consumer<WorkflowDetails.Builder> workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
UpdateServerRequest.Builder |
workflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildUpdateServerRequest.Builder certificate(String certificate)
The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate 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)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
certificate - The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate.
Required when Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate 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)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
UpdateServerRequest.Builder protocolDetails(ProtocolDetails 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 the SetStatOption parameter. To have the
Transfer Family server ignore the SETSTAT command and upload files without needing to make any
changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the
SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to
Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.
To determine whether your 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.
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 the SetStatOption parameter.
To have the Transfer Family server ignore the SETSTAT command and upload files without
needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you
set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a
log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a
SETSTAT call.
To determine whether your 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.
default UpdateServerRequest.Builder protocolDetails(Consumer<ProtocolDetails.Builder> 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 the SetStatOption parameter. To have the
Transfer Family server ignore the SETSTAT command and upload files without needing to make any
changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the
SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to
Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.
To determine whether your 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.
ProtocolDetails.Builder avoiding the
need to create one manually via ProtocolDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to protocolDetails(ProtocolDetails).
protocolDetails - a consumer that will call methods on ProtocolDetails.BuilderprotocolDetails(ProtocolDetails)UpdateServerRequest.Builder endpointDetails(EndpointDetails 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.
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.default UpdateServerRequest.Builder endpointDetails(Consumer<EndpointDetails.Builder> 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.
This is a convenience method that creates an instance of theEndpointDetails.Builder avoiding the
need to create one manually via EndpointDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to endpointDetails(EndpointDetails).
endpointDetails - a consumer that will call methods on EndpointDetails.BuilderendpointDetails(EndpointDetails)UpdateServerRequest.Builder endpointType(String 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.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your
Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already
created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before
May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
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.
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.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you
have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web
Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use
EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html #deprecate-vpc-endpoint.
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.
EndpointType,
EndpointTypeUpdateServerRequest.Builder endpointType(EndpointType 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.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your
Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already
created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before
May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
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.
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.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you
have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web
Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use
EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html #deprecate-vpc-endpoint.
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.
EndpointType,
EndpointTypeUpdateServerRequest.Builder hostKey(String 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.
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 Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.
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.
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 Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.
UpdateServerRequest.Builder identityProviderDetails(IdentityProviderDetails identityProviderDetails)
An array containing all of the information required to call a customer's authentication API method.
identityProviderDetails - An array containing all of the information required to call a customer's authentication API method.default UpdateServerRequest.Builder identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)
An array containing all of the information required to call a customer's authentication API method.
This is a convenience method that creates an instance of theIdentityProviderDetails.Builder avoiding
the need to create one manually via IdentityProviderDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to identityProviderDetails(IdentityProviderDetails).
identityProviderDetails - a consumer that will call methods on IdentityProviderDetails.BuilderidentityProviderDetails(IdentityProviderDetails)UpdateServerRequest.Builder loggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the 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.
loggingRole - The Amazon Resource Name (ARN) of the 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.UpdateServerRequest.Builder postAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
postAuthenticationLoginBanner - Specifies a string to display when users connect to a server. This string is displayed after the user
authenticates. The SFTP protocol does not support post-authentication display banners.
UpdateServerRequest.Builder preAuthenticationLoginBanner(String 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.
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.
UpdateServerRequest.Builder protocolsWithStrings(Collection<String> 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
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is
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 either
AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or 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 any of the supported identity types:
SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or
API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be
VPC, and domain must be Amazon S3.
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
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM)
which is 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
either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or 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 any of the supported identity
types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or
API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be
VPC, and domain must be Amazon S3.
UpdateServerRequest.Builder protocolsWithStrings(String... 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
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is
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 either
AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or 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 any of the supported identity types:
SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or
API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be
VPC, and domain must be Amazon S3.
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
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM)
which is 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
either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or 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 any of the supported identity
types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or
API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be
VPC, and domain must be Amazon S3.
UpdateServerRequest.Builder protocols(Collection<Protocol> 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
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is
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 either
AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or 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 any of the supported identity types:
SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or
API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be
VPC, and domain must be Amazon S3.
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
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM)
which is 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
either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or 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 any of the supported identity
types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or
API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be
VPC, and domain must be Amazon S3.
UpdateServerRequest.Builder protocols(Protocol... 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
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is
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 either
AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or 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 any of the supported identity types:
SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or
API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be
VPC, and domain must be Amazon S3.
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
If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM)
which is 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
either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or 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 any of the supported identity
types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or
API_GATEWAY.
If Protocol includes AS2, then the EndpointType must be
VPC, and domain must be Amazon S3.
UpdateServerRequest.Builder securityPolicyName(String securityPolicyName)
Specifies the name of the security policy that is attached to the server.
securityPolicyName - Specifies the name of the security policy that is attached to the server.UpdateServerRequest.Builder serverId(String serverId)
A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
serverId - A system-assigned unique identifier for a server instance that the Transfer Family user is assigned
to.UpdateServerRequest.Builder workflowDetails(WorkflowDetails 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":[]}'
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":[]}'
default UpdateServerRequest.Builder workflowDetails(Consumer<WorkflowDetails.Builder> 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":[]}'
WorkflowDetails.Builder avoiding the
need to create one manually via WorkflowDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to workflowDetails(WorkflowDetails).
workflowDetails - a consumer that will call methods on WorkflowDetails.BuilderworkflowDetails(WorkflowDetails)UpdateServerRequest.Builder structuredLogDestinations(Collection<String> 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
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
UpdateServerRequest.Builder structuredLogDestinations(String... 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
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
UpdateServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderUpdateServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.