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 private key as generated by
ssh-keygen -N "" -m PEM -f my-new-server-key. |
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)
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role
that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events.
|
UpdateServerRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
UpdateServerRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
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 user account is assigned to.
|
default UpdateServerRequest.Builder |
workflowDetails(Consumer<WorkflowDetails.Builder> workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
|
UpdateServerRequest.Builder |
workflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role 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.
Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a
single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
protocolDetails - The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter
a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load
balancer.
default UpdateServerRequest.Builder protocolDetails(Consumer<ProtocolDetails.Builder> protocolDetails)
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a
single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
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 it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it 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 it accessible only to resources within your VPC, or you
can attach Elastic IP addresses and make it 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 it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
This is a convenience 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 private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.
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 Amazon Web ServicesTransfer Family User Guide.
hostKey - The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.
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 Amazon Web ServicesTransfer 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 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)
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
loggingRole - Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management
(IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS
events. When set, user activity can be viewed in your CloudWatch logs.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:
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
If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate
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
AWS_DIRECTORY_SERVICE 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 to SERVICE_MANAGED.
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:
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
If you select FTPS, you must choose a certificate stored in Amazon Web
ServicesCertificate 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
AWS_DIRECTORY_SERVICE 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 to
SERVICE_MANAGED.
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:
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
If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate
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
AWS_DIRECTORY_SERVICE 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 to SERVICE_MANAGED.
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:
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
If you select FTPS, you must choose a certificate stored in Amazon Web
ServicesCertificate 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
AWS_DIRECTORY_SERVICE 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 to
SERVICE_MANAGED.
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:
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
If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate
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
AWS_DIRECTORY_SERVICE 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 to SERVICE_MANAGED.
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:
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
If you select FTPS, you must choose a certificate stored in Amazon Web
ServicesCertificate 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
AWS_DIRECTORY_SERVICE 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 to
SERVICE_MANAGED.
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:
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
If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate
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
AWS_DIRECTORY_SERVICE 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 to SERVICE_MANAGED.
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:
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
If you select FTPS, you must choose a certificate stored in Amazon Web
ServicesCertificate 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
AWS_DIRECTORY_SERVICE 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 to
SERVICE_MANAGED.
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 user account is assigned to.
serverId - A system-assigned unique identifier for a server instance that the user account is assigned to.UpdateServerRequest.Builder workflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role used for executing the
workflow.default UpdateServerRequest.Builder workflowDetails(Consumer<WorkflowDetails.Builder> workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
This is a convenience that creates an instance of theWorkflowDetails.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 overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.UpdateServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.