com.amazonaws.services.transfer.model.UpdateServerRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transfer Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.transfer.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateServerRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*
*/
private String certificate;
/**
*
* 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.
*
*
*
*/
private ProtocolDetails protocolDetails;
/**
*
* 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.
*
*/
private EndpointDetails endpointDetails;
/**
*
* 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.
*
*
*/
private String endpointType;
/**
*
* 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.
*
*/
private String hostKey;
/**
*
* An array containing all of the information required to call a customer's authentication API method.
*
*/
private IdentityProviderDetails identityProviderDetails;
/**
*
* 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.
*
*/
private String loggingRole;
/**
*
* 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.
*
*
*/
private String postAuthenticationLoginBanner;
/**
*
* 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.
*
*/
private String preAuthenticationLoginBanner;
/**
*
* 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.
*
*
*
*
*/
private java.util.List protocols;
/**
*
* Specifies the name of the security policy for the server.
*
*/
private String securityPolicyName;
/**
*
* A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
*
*/
private String serverId;
/**
*
* 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":[]}'
*
*/
private WorkflowDetails workflowDetails;
/**
*
* 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
*
*/
private java.util.List structuredLogDestinations;
/**
*
* 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.
*
*/
private S3StorageOptions s3StorageOptions;
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setCertificate(String certificate) {
this.certificate = 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.
*
*
*
* @return 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.
*
*/
public String getCertificate() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withCertificate(String certificate) {
setCertificate(certificate);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setProtocolDetails(ProtocolDetails protocolDetails) {
this.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.
*
*
*
*
* @return 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.
*
*
*/
public ProtocolDetails getProtocolDetails() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withProtocolDetails(ProtocolDetails protocolDetails) {
setProtocolDetails(protocolDetails);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setEndpointDetails(EndpointDetails endpointDetails) {
this.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.
*
*
* @return 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.
*/
public EndpointDetails getEndpointDetails() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withEndpointDetails(EndpointDetails endpointDetails) {
setEndpointDetails(endpointDetails);
return this;
}
/**
*
* 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.
*
*
*
* @param 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 EndpointType
*/
public void setEndpointType(String endpointType) {
this.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.
*
*
*
* @return 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 EndpointType
*/
public String getEndpointType() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EndpointType
*/
public UpdateServerRequest withEndpointType(String endpointType) {
setEndpointType(endpointType);
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see EndpointType
*/
public UpdateServerRequest withEndpointType(EndpointType endpointType) {
this.endpointType = endpointType.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setHostKey(String hostKey) {
this.hostKey = 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.
*
*
* @return 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.
*/
public String getHostKey() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withHostKey(String hostKey) {
setHostKey(hostKey);
return this;
}
/**
*
* An array containing all of the information required to call a customer's authentication API method.
*
*
* @param identityProviderDetails
* An array containing all of the information required to call a customer's authentication API method.
*/
public void setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) {
this.identityProviderDetails = identityProviderDetails;
}
/**
*
* An array containing all of the information required to call a customer's authentication API method.
*
*
* @return An array containing all of the information required to call a customer's authentication API method.
*/
public IdentityProviderDetails getIdentityProviderDetails() {
return this.identityProviderDetails;
}
/**
*
* An array containing all of the information required to call a customer's authentication API method.
*
*
* @param identityProviderDetails
* An array containing all of the information required to call a customer's authentication API method.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) {
setIdentityProviderDetails(identityProviderDetails);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setLoggingRole(String loggingRole) {
this.loggingRole = 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.
*
*
* @return 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.
*/
public String getLoggingRole() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withLoggingRole(String loggingRole) {
setLoggingRole(loggingRole);
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setPostAuthenticationLoginBanner(String postAuthenticationLoginBanner) {
this.postAuthenticationLoginBanner = 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.
*
*
*
* @return 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.
*
*/
public String getPostAuthenticationLoginBanner() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withPostAuthenticationLoginBanner(String postAuthenticationLoginBanner) {
setPostAuthenticationLoginBanner(postAuthenticationLoginBanner);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPreAuthenticationLoginBanner(String preAuthenticationLoginBanner) {
this.preAuthenticationLoginBanner = 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.
*
*
* @return 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.
*/
public String getPreAuthenticationLoginBanner() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withPreAuthenticationLoginBanner(String preAuthenticationLoginBanner) {
setPreAuthenticationLoginBanner(preAuthenticationLoginBanner);
return this;
}
/**
*
* 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.
*
*
*
*
*
* @return 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 Protocol
*/
public java.util.List getProtocols() {
return 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.
*
*
*
*
*
* @param 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 Protocol
*/
public void setProtocols(java.util.Collection protocols) {
if (protocols == null) {
this.protocols = null;
return;
}
this.protocols = new java.util.ArrayList(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
* {@link #setProtocols(java.util.Collection)} or {@link #withProtocols(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Protocol
*/
public UpdateServerRequest withProtocols(String... protocols) {
if (this.protocols == null) {
setProtocols(new java.util.ArrayList(protocols.length));
}
for (String ele : protocols) {
this.protocols.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
*
* @param 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.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Protocol
*/
public UpdateServerRequest withProtocols(java.util.Collection protocols) {
setProtocols(protocols);
return this;
}
/**
*
* 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.
*
*
*
*
*
* @param 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.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Protocol
*/
public UpdateServerRequest withProtocols(Protocol... protocols) {
java.util.ArrayList protocolsCopy = new java.util.ArrayList(protocols.length);
for (Protocol value : protocols) {
protocolsCopy.add(value.toString());
}
if (getProtocols() == null) {
setProtocols(protocolsCopy);
} else {
getProtocols().addAll(protocolsCopy);
}
return this;
}
/**
*
* Specifies the name of the security policy for the server.
*
*
* @param securityPolicyName
* Specifies the name of the security policy for the server.
*/
public void setSecurityPolicyName(String securityPolicyName) {
this.securityPolicyName = securityPolicyName;
}
/**
*
* Specifies the name of the security policy for the server.
*
*
* @return Specifies the name of the security policy for the server.
*/
public String getSecurityPolicyName() {
return this.securityPolicyName;
}
/**
*
* Specifies the name of the security policy for the server.
*
*
* @param securityPolicyName
* Specifies the name of the security policy for the server.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withSecurityPolicyName(String securityPolicyName) {
setSecurityPolicyName(securityPolicyName);
return this;
}
/**
*
* A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
*
*
* @param serverId
* A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
*/
public void setServerId(String serverId) {
this.serverId = serverId;
}
/**
*
* A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
*
*
* @return A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
*/
public String getServerId() {
return this.serverId;
}
/**
*
* A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
*
*
* @param serverId
* A system-assigned unique identifier for a server instance that the Transfer Family user is assigned to.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withServerId(String serverId) {
setServerId(serverId);
return this;
}
/**
*
* 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":[]}'
*
*
* @param 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":[]}'
*/
public void setWorkflowDetails(WorkflowDetails workflowDetails) {
this.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":[]}'
*
*
* @return 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":[]}'
*/
public WorkflowDetails getWorkflowDetails() {
return this.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":[]}'
*
*
* @param 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":[]}'
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withWorkflowDetails(WorkflowDetails workflowDetails) {
setWorkflowDetails(workflowDetails);
return this;
}
/**
*
* 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
*
*
* @return 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
*/
public java.util.List getStructuredLogDestinations() {
return 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
*
*
* @param 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
*/
public void setStructuredLogDestinations(java.util.Collection structuredLogDestinations) {
if (structuredLogDestinations == null) {
this.structuredLogDestinations = null;
return;
}
this.structuredLogDestinations = new java.util.ArrayList(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
* {@link #setStructuredLogDestinations(java.util.Collection)} or
* {@link #withStructuredLogDestinations(java.util.Collection)} if you want to override the existing values.
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withStructuredLogDestinations(String... structuredLogDestinations) {
if (this.structuredLogDestinations == null) {
setStructuredLogDestinations(new java.util.ArrayList(structuredLogDestinations.length));
}
for (String ele : structuredLogDestinations) {
this.structuredLogDestinations.add(ele);
}
return this;
}
/**
*
* 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
*
*
* @param 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withStructuredLogDestinations(java.util.Collection structuredLogDestinations) {
setStructuredLogDestinations(structuredLogDestinations);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setS3StorageOptions(S3StorageOptions s3StorageOptions) {
this.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.
*
*
* @return 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.
*/
public S3StorageOptions getS3StorageOptions() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateServerRequest withS3StorageOptions(S3StorageOptions s3StorageOptions) {
setS3StorageOptions(s3StorageOptions);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCertificate() != null)
sb.append("Certificate: ").append(getCertificate()).append(",");
if (getProtocolDetails() != null)
sb.append("ProtocolDetails: ").append(getProtocolDetails()).append(",");
if (getEndpointDetails() != null)
sb.append("EndpointDetails: ").append(getEndpointDetails()).append(",");
if (getEndpointType() != null)
sb.append("EndpointType: ").append(getEndpointType()).append(",");
if (getHostKey() != null)
sb.append("HostKey: ").append("***Sensitive Data Redacted***").append(",");
if (getIdentityProviderDetails() != null)
sb.append("IdentityProviderDetails: ").append(getIdentityProviderDetails()).append(",");
if (getLoggingRole() != null)
sb.append("LoggingRole: ").append(getLoggingRole()).append(",");
if (getPostAuthenticationLoginBanner() != null)
sb.append("PostAuthenticationLoginBanner: ").append(getPostAuthenticationLoginBanner()).append(",");
if (getPreAuthenticationLoginBanner() != null)
sb.append("PreAuthenticationLoginBanner: ").append(getPreAuthenticationLoginBanner()).append(",");
if (getProtocols() != null)
sb.append("Protocols: ").append(getProtocols()).append(",");
if (getSecurityPolicyName() != null)
sb.append("SecurityPolicyName: ").append(getSecurityPolicyName()).append(",");
if (getServerId() != null)
sb.append("ServerId: ").append(getServerId()).append(",");
if (getWorkflowDetails() != null)
sb.append("WorkflowDetails: ").append(getWorkflowDetails()).append(",");
if (getStructuredLogDestinations() != null)
sb.append("StructuredLogDestinations: ").append(getStructuredLogDestinations()).append(",");
if (getS3StorageOptions() != null)
sb.append("S3StorageOptions: ").append(getS3StorageOptions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateServerRequest == false)
return false;
UpdateServerRequest other = (UpdateServerRequest) obj;
if (other.getCertificate() == null ^ this.getCertificate() == null)
return false;
if (other.getCertificate() != null && other.getCertificate().equals(this.getCertificate()) == false)
return false;
if (other.getProtocolDetails() == null ^ this.getProtocolDetails() == null)
return false;
if (other.getProtocolDetails() != null && other.getProtocolDetails().equals(this.getProtocolDetails()) == false)
return false;
if (other.getEndpointDetails() == null ^ this.getEndpointDetails() == null)
return false;
if (other.getEndpointDetails() != null && other.getEndpointDetails().equals(this.getEndpointDetails()) == false)
return false;
if (other.getEndpointType() == null ^ this.getEndpointType() == null)
return false;
if (other.getEndpointType() != null && other.getEndpointType().equals(this.getEndpointType()) == false)
return false;
if (other.getHostKey() == null ^ this.getHostKey() == null)
return false;
if (other.getHostKey() != null && other.getHostKey().equals(this.getHostKey()) == false)
return false;
if (other.getIdentityProviderDetails() == null ^ this.getIdentityProviderDetails() == null)
return false;
if (other.getIdentityProviderDetails() != null && other.getIdentityProviderDetails().equals(this.getIdentityProviderDetails()) == false)
return false;
if (other.getLoggingRole() == null ^ this.getLoggingRole() == null)
return false;
if (other.getLoggingRole() != null && other.getLoggingRole().equals(this.getLoggingRole()) == false)
return false;
if (other.getPostAuthenticationLoginBanner() == null ^ this.getPostAuthenticationLoginBanner() == null)
return false;
if (other.getPostAuthenticationLoginBanner() != null
&& other.getPostAuthenticationLoginBanner().equals(this.getPostAuthenticationLoginBanner()) == false)
return false;
if (other.getPreAuthenticationLoginBanner() == null ^ this.getPreAuthenticationLoginBanner() == null)
return false;
if (other.getPreAuthenticationLoginBanner() != null && other.getPreAuthenticationLoginBanner().equals(this.getPreAuthenticationLoginBanner()) == false)
return false;
if (other.getProtocols() == null ^ this.getProtocols() == null)
return false;
if (other.getProtocols() != null && other.getProtocols().equals(this.getProtocols()) == false)
return false;
if (other.getSecurityPolicyName() == null ^ this.getSecurityPolicyName() == null)
return false;
if (other.getSecurityPolicyName() != null && other.getSecurityPolicyName().equals(this.getSecurityPolicyName()) == false)
return false;
if (other.getServerId() == null ^ this.getServerId() == null)
return false;
if (other.getServerId() != null && other.getServerId().equals(this.getServerId()) == false)
return false;
if (other.getWorkflowDetails() == null ^ this.getWorkflowDetails() == null)
return false;
if (other.getWorkflowDetails() != null && other.getWorkflowDetails().equals(this.getWorkflowDetails()) == false)
return false;
if (other.getStructuredLogDestinations() == null ^ this.getStructuredLogDestinations() == null)
return false;
if (other.getStructuredLogDestinations() != null && other.getStructuredLogDestinations().equals(this.getStructuredLogDestinations()) == false)
return false;
if (other.getS3StorageOptions() == null ^ this.getS3StorageOptions() == null)
return false;
if (other.getS3StorageOptions() != null && other.getS3StorageOptions().equals(this.getS3StorageOptions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getCertificate() == null) ? 0 : getCertificate().hashCode());
hashCode = prime * hashCode + ((getProtocolDetails() == null) ? 0 : getProtocolDetails().hashCode());
hashCode = prime * hashCode + ((getEndpointDetails() == null) ? 0 : getEndpointDetails().hashCode());
hashCode = prime * hashCode + ((getEndpointType() == null) ? 0 : getEndpointType().hashCode());
hashCode = prime * hashCode + ((getHostKey() == null) ? 0 : getHostKey().hashCode());
hashCode = prime * hashCode + ((getIdentityProviderDetails() == null) ? 0 : getIdentityProviderDetails().hashCode());
hashCode = prime * hashCode + ((getLoggingRole() == null) ? 0 : getLoggingRole().hashCode());
hashCode = prime * hashCode + ((getPostAuthenticationLoginBanner() == null) ? 0 : getPostAuthenticationLoginBanner().hashCode());
hashCode = prime * hashCode + ((getPreAuthenticationLoginBanner() == null) ? 0 : getPreAuthenticationLoginBanner().hashCode());
hashCode = prime * hashCode + ((getProtocols() == null) ? 0 : getProtocols().hashCode());
hashCode = prime * hashCode + ((getSecurityPolicyName() == null) ? 0 : getSecurityPolicyName().hashCode());
hashCode = prime * hashCode + ((getServerId() == null) ? 0 : getServerId().hashCode());
hashCode = prime * hashCode + ((getWorkflowDetails() == null) ? 0 : getWorkflowDetails().hashCode());
hashCode = prime * hashCode + ((getStructuredLogDestinations() == null) ? 0 : getStructuredLogDestinations().hashCode());
hashCode = prime * hashCode + ((getS3StorageOptions() == null) ? 0 : getS3StorageOptions().hashCode());
return hashCode;
}
@Override
public UpdateServerRequest clone() {
return (UpdateServerRequest) super.clone();
}
}