UpdateServerRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.transfer.model.UpdateServerRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateServerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

UpdateServerRequest()

Constructors
Constructor and Description
`UpdateServerRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateServerRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getCertificate()` The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate.
`EndpointDetails`	`getEndpointDetails()` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`String`	`getEndpointType()` The type of endpoint that you want your server to use.
`String`	`getHostKey()` The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
`IdentityProviderDetails`	`getIdentityProviderDetails()` An array containing all of the information required to call a customer's authentication API method.
`String`	`getLoggingRole()` 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.
`String`	`getPostAuthenticationLoginBanner()` Specifies a string to display when users connect to a server.
`String`	`getPreAuthenticationLoginBanner()` Specifies a string to display when users connect to a server.
`ProtocolDetails`	`getProtocolDetails()` The protocol settings that are configured for your server.
`List<String>`	`getProtocols()` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`S3StorageOptions`	`getS3StorageOptions()` Specifies whether or not performance for your Amazon S3 directories is optimized.
`String`	`getSecurityPolicyName()` Specifies the name of the security policy for the server.
`String`	`getServerId()` A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
`List<String>`	`getStructuredLogDestinations()` Specifies the log groups to which your server logs are sent.
`WorkflowDetails`	`getWorkflowDetails()` Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
`int`	`hashCode()`
`void`	`setCertificate(String certificate)` The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate.
`void`	`setEndpointDetails(EndpointDetails endpointDetails)` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`void`	`setEndpointType(String endpointType)` The type of endpoint that you want your server to use.
`void`	`setHostKey(String hostKey)` The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
`void`	`setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)` An array containing all of the information required to call a customer's authentication API method.
`void`	`setLoggingRole(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.
`void`	`setPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)` Specifies a string to display when users connect to a server.
`void`	`setPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)` Specifies a string to display when users connect to a server.
`void`	`setProtocolDetails(ProtocolDetails protocolDetails)` The protocol settings that are configured for your server.
`void`	`setProtocols(Collection<String> protocols)` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`void`	`setS3StorageOptions(S3StorageOptions s3StorageOptions)` Specifies whether or not performance for your Amazon S3 directories is optimized.
`void`	`setSecurityPolicyName(String securityPolicyName)` Specifies the name of the security policy for the server.
`void`	`setServerId(String serverId)` A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
`void`	`setStructuredLogDestinations(Collection<String> structuredLogDestinations)` Specifies the log groups to which your server logs are sent.
`void`	`setWorkflowDetails(WorkflowDetails workflowDetails)` Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
`String`	`toString()` Returns a string representation of this object.
`UpdateServerRequest`	`withCertificate(String certificate)` The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate.
`UpdateServerRequest`	`withEndpointDetails(EndpointDetails endpointDetails)` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`UpdateServerRequest`	`withEndpointType(EndpointType endpointType)` The type of endpoint that you want your server to use.
`UpdateServerRequest`	`withEndpointType(String endpointType)` The type of endpoint that you want your server to use.
`UpdateServerRequest`	`withHostKey(String hostKey)` The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
`UpdateServerRequest`	`withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)` An array containing all of the information required to call a customer's authentication API method.
`UpdateServerRequest`	`withLoggingRole(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`	`withPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)` Specifies a string to display when users connect to a server.
`UpdateServerRequest`	`withPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)` Specifies a string to display when users connect to a server.
`UpdateServerRequest`	`withProtocolDetails(ProtocolDetails protocolDetails)` The protocol settings that are configured for your server.
`UpdateServerRequest`	`withProtocols(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`	`withProtocols(Protocol... protocols)` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`UpdateServerRequest`	`withProtocols(String... protocols)` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`UpdateServerRequest`	`withS3StorageOptions(S3StorageOptions s3StorageOptions)` Specifies whether or not performance for your Amazon S3 directories is optimized.
`UpdateServerRequest`	`withSecurityPolicyName(String securityPolicyName)` Specifies the name of the security policy for the server.
`UpdateServerRequest`	`withServerId(String serverId)` A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
`UpdateServerRequest`	`withStructuredLogDestinations(Collection<String> structuredLogDestinations)` Specifies the log groups to which your server logs are sent.
`UpdateServerRequest`	`withStructuredLogDestinations(String... structuredLogDestinations)` Specifies the log groups to which your server logs are sent.
`UpdateServerRequest`	`withWorkflowDetails(WorkflowDetails workflowDetails)` Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateServerRequest
```
public UpdateServerRequest()
```
- Method Detail
  - setCertificate
```
public void setCertificate(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.
    Parameters:
    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.
  - getCertificate
```
public String getCertificate()
```
    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.
    Returns:
    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.
  - withCertificate
```
public UpdateServerRequest withCertificate(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProtocolDetails
```
public void setProtocolDetails(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.
    Parameters:
    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.
  - getProtocolDetails
```
public ProtocolDetails getProtocolDetails()
```
    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.
    Returns:
    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.
  - withProtocolDetails
```
public UpdateServerRequest withProtocolDetails(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointDetails
```
public void setEndpointDetails(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.
    
    Parameters:
    
    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.
  - getEndpointDetails
```
public EndpointDetails getEndpointDetails()
```
    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.
    
    Returns:
    
    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.
  - withEndpointDetails
```
public UpdateServerRequest withEndpointDetails(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointType
```
public void setEndpointType(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.
    
    Parameters:
    
    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.
    
    See Also:
    
    EndpointType
  - getEndpointType
```
public String getEndpointType()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public UpdateServerRequest withEndpointType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - withEndpointType
```
public UpdateServerRequest withEndpointType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType
  - setHostKey
```
public void setHostKey(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.
    
    Parameters:
    
    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.
  - getHostKey
```
public String getHostKey()
```
    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.
    
    Returns:
    
    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.
  - withHostKey
```
public UpdateServerRequest withHostKey(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdentityProviderDetails
```
public void setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
```
    An array containing all of the information required to call a customer's authentication API method.
    
    Parameters:
    
    identityProviderDetails - An array containing all of the information required to call a customer's authentication API method.
  - getIdentityProviderDetails
```
public IdentityProviderDetails getIdentityProviderDetails()
```
    An array containing all of the information required to call a customer's authentication API method.
    
    Returns:
    
    An array containing all of the information required to call a customer's authentication API method.
  - withIdentityProviderDetails
```
public UpdateServerRequest withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
```
    An array containing all of the information required to call a customer's authentication API method.
    
    Parameters:
    
    identityProviderDetails - An array containing all of the information required to call a customer's authentication API method.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoggingRole
```
public void setLoggingRole(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.
    
    Parameters:
    
    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.
  - getLoggingRole
```
public String getLoggingRole()
```
    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.
    
    Returns:
    
    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.
  - withLoggingRole
```
public UpdateServerRequest withLoggingRole(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPostAuthenticationLoginBanner
```
public void setPostAuthenticationLoginBanner(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.
    
    Parameters:
    
    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.
  - getPostAuthenticationLoginBanner
```
public String getPostAuthenticationLoginBanner()
```
    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.
    
    Returns:
    
    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.
  - withPostAuthenticationLoginBanner
```
public UpdateServerRequest withPostAuthenticationLoginBanner(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreAuthenticationLoginBanner
```
public void setPreAuthenticationLoginBanner(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.
    
    Parameters:
    
    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.
  - getPreAuthenticationLoginBanner
```
public String getPreAuthenticationLoginBanner()
```
    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.
    
    Returns:
    
    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.
  - withPreAuthenticationLoginBanner
```
public UpdateServerRequest withPreAuthenticationLoginBanner(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getProtocols
```
public List<String> getProtocols()
```
    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.
    Returns:
    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.
    See Also:
    
    Protocol
  - setProtocols
```
public void setProtocols(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.
    Parameters:
    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.
    See Also:
    
    Protocol
  - withProtocols
```
public UpdateServerRequest withProtocols(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.
    NOTE: This method appends the values to the existing list (if any). Use setProtocols(java.util.Collection) or withProtocols(java.util.Collection) if you want to override the existing values.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Protocol
  - withProtocols
```
public UpdateServerRequest withProtocols(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Protocol
  - withProtocols
```
public UpdateServerRequest withProtocols(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Protocol
  - setSecurityPolicyName
```
public void setSecurityPolicyName(String securityPolicyName)
```
    Specifies the name of the security policy for the server.
    
    Parameters:
    
    securityPolicyName - Specifies the name of the security policy for the server.
  - getSecurityPolicyName
```
public String getSecurityPolicyName()
```
    Specifies the name of the security policy for the server.
    
    Returns:
    
    Specifies the name of the security policy for the server.
  - withSecurityPolicyName
```
public UpdateServerRequest withSecurityPolicyName(String securityPolicyName)
```
    Specifies the name of the security policy for the server.
    
    Parameters:
    
    securityPolicyName - Specifies the name of the security policy for the server.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServerId
```
public void setServerId(String serverId)
```
    A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
    
    Parameters:
    
    serverId - A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
  - getServerId
```
public String getServerId()
```
    A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
    
    Returns:
    
    A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
  - withServerId
```
public UpdateServerRequest withServerId(String serverId)
```
    A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
    
    Parameters:
    
    serverId - A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkflowDetails
```
public void setWorkflowDetails(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":[]}'
    
    Parameters:
    
    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":[]}'
  - getWorkflowDetails
```
public WorkflowDetails getWorkflowDetails()
```
    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":[]}'
    
    Returns:
    
    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":[]}'
  - withWorkflowDetails
```
public UpdateServerRequest withWorkflowDetails(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":[]}'
    
    Parameters:
    
    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":[]}'
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStructuredLogDestinations
```
public List<String> getStructuredLogDestinations()
```
    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
    
    Returns:
    
    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
  - setStructuredLogDestinations
```
public void setStructuredLogDestinations(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
    
    Parameters:
    
    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
  - withStructuredLogDestinations
```
public UpdateServerRequest withStructuredLogDestinations(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
    
    NOTE: This method appends the values to the existing list (if any). Use setStructuredLogDestinations(java.util.Collection) or withStructuredLogDestinations(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStructuredLogDestinations
```
public UpdateServerRequest withStructuredLogDestinations(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
    
    Parameters:
    
    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
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3StorageOptions
```
public void setS3StorageOptions(S3StorageOptions 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 of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.
    
    Parameters:
    
    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 of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.
  - getS3StorageOptions
```
public S3StorageOptions getS3StorageOptions()
```
    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 of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.
    
    Returns:
    
    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 of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.
  - withS3StorageOptions
```
public UpdateServerRequest withS3StorageOptions(S3StorageOptions 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 of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.
    
    Parameters:
    
    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 of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateServerRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Select your cookie preferences

AWS SDK for Java 1.x API Reference - 1.12.782

Class UpdateServerRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateServerRequest

Method Detail

setCertificate

getCertificate

withCertificate

setProtocolDetails

getProtocolDetails

withProtocolDetails

setEndpointDetails

getEndpointDetails

withEndpointDetails

setEndpointType

getEndpointType

withEndpointType

withEndpointType

setHostKey

getHostKey

withHostKey

setIdentityProviderDetails

getIdentityProviderDetails

withIdentityProviderDetails

setLoggingRole

getLoggingRole

withLoggingRole

setPostAuthenticationLoginBanner

getPostAuthenticationLoginBanner

withPostAuthenticationLoginBanner

setPreAuthenticationLoginBanner

getPreAuthenticationLoginBanner

withPreAuthenticationLoginBanner

getProtocols

setProtocols

withProtocols

withProtocols

withProtocols

setSecurityPolicyName

getSecurityPolicyName

withSecurityPolicyName

setServerId

getServerId

withServerId

setWorkflowDetails

getWorkflowDetails

withWorkflowDetails

getStructuredLogDestinations

setStructuredLogDestinations

withStructuredLogDestinations

withStructuredLogDestinations

setS3StorageOptions

getS3StorageOptions

withS3StorageOptions

toString

equals

hashCode

clone