/* * Copyright 2018-2023 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 CreateServerRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

* The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols * is set to FTPS. *

* To request a new public certificate, see Request a public * certificate in the Certificate Manager User Guide. *

* To import an existing certificate into ACM, see Importing certificates into * ACM in the Certificate Manager User Guide. *

* To request a private certificate to use FTPS through private IP addresses, see Request a private * certificate in the Certificate 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 domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple * Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3. *

* *

* After the server is created, the domain cannot be changed. *

* */ private String domain; /** *

* 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 Services account 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 Services account 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; /** *

* Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, * Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of the * information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied * authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to * SERVICE_MANAGED. *

*/ private IdentityProviderDetails identityProviderDetails; /** *

* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to * store and access user credentials within the Transfer Family service. *

* Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for * Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web * Services using AD Connector. This option also requires you to provide a Directory ID by using the * IdentityProviderDetails parameter. *

* Use the API_GATEWAY value to integrate with an identity provider of your choosing. The * API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for * authentication by using the IdentityProviderDetails parameter. *

* Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose * this value, you must specify the ARN for the Lambda function in the Function parameter for the * IdentityProviderDetails data type. *

*/ private String identityProviderType; /** *

* 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: *

*/ 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; /** *

* 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; /** *

* Specifies the name of the security policy that is attached to the server. *

*/ private String securityPolicyName; /** *

* Key-value pairs that can be used to group and search for servers. *

*/ private java.util.List tags; /** *

* 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. *

*/ 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; /** *

* The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when Protocols * is set to FTPS. *

* To request a new public certificate, see Request a public * certificate in the Certificate Manager User Guide. *

* To import an existing certificate into ACM, see Importing certificates into * ACM in the Certificate Manager User Guide. *

* To request a private certificate to use FTPS through private IP addresses, see Request a private * certificate in the Certificate 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 Certificate Manager (ACM) certificate. Required when * Protocols is set to FTPS.

* To request a new public certificate, see Request a public * certificate in the Certificate Manager User Guide. *

* To import an existing certificate into ACM, see Importing certificates * into ACM in the Certificate Manager User Guide. *

* To request a private certificate to use FTPS through private IP addresses, see Request a private * certificate in the Certificate 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 Certificate Manager (ACM) certificate. Required when Protocols * is set to FTPS. *

* To request a new public certificate, see Request a public * certificate in the Certificate Manager User Guide. *

* To import an existing certificate into ACM, see Importing certificates into * ACM in the Certificate Manager User Guide. *

* To request a private certificate to use FTPS through private IP addresses, see Request a private * certificate in the Certificate 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 Certificate Manager (ACM) certificate. Required when * Protocols is set to FTPS.

* To request a new public certificate, see Request a public * certificate in the Certificate Manager User Guide. *

* To import an existing certificate into ACM, see Importing certificates * into ACM in the Certificate Manager User Guide. *

* To request a private certificate to use FTPS through private IP addresses, see Request a private * certificate in the Certificate 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 Certificate Manager (ACM) certificate. Required when Protocols * is set to FTPS. *

* To request a new public certificate, see Request a public * certificate in the Certificate Manager User Guide. *

* To import an existing certificate into ACM, see Importing certificates into * ACM in the Certificate Manager User Guide. *

* To request a private certificate to use FTPS through private IP addresses, see Request a private * certificate in the Certificate 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 Certificate Manager (ACM) certificate. Required when * Protocols is set to FTPS.

* To request a new public certificate, see Request a public * certificate in the Certificate Manager User Guide. *

* To import an existing certificate into ACM, see Importing certificates * into ACM in the Certificate Manager User Guide. *

* To request a private certificate to use FTPS through private IP addresses, see Request a private * certificate in the Certificate 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 CreateServerRequest withCertificate(String certificate) { setCertificate(certificate); return this; } /** *

* *

* After the server is created, the domain cannot be changed. *

* * * @param domain * The domain of the storage system that is used for file transfers. There are two domains available: Amazon * Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is * S3.

* After the server is created, the domain cannot be changed. *

* @see Domain */ public void setDomain(String domain) { this.domain = domain; } /** *

* *

* After the server is created, the domain cannot be changed. *

* * * @return The domain of the storage system that is used for file transfers. There are two domains available: Amazon * Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is * S3.

* After the server is created, the domain cannot be changed. *

* @see Domain */ public String getDomain() { return this.domain; } /** *

* *

* After the server is created, the domain cannot be changed. *

* @return Returns a reference to this object so that method calls can be chained together. * @see Domain */ public CreateServerRequest withDomain(String domain) { setDomain(domain); return this; } /** *

* *

* After the server is created, the domain cannot be changed. *

* @return Returns a reference to this object so that method calls can be chained together. * @see Domain */ public CreateServerRequest withDomain(Domain domain) { this.domain = domain.toString(); return this; } /** *

* * @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; } /** *

* * @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; } /** *

* * @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 CreateServerRequest withEndpointDetails(EndpointDetails endpointDetails) { setEndpointDetails(endpointDetails); return this; } /** *

* *

* For more information, see * https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-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 Services account 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 Services account 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; } /** *

* *

* For more information, see * https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-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 Services account 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 Services account * 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; } /** *

* *

* For more information, see * https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. *

* @return Returns a reference to this object so that method calls can be chained together. * @see EndpointType */ public CreateServerRequest withEndpointType(String endpointType) { setEndpointType(endpointType); return this; } /** *

* *

* For more information, see * https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint. *

* @return Returns a reference to this object so that method calls can be chained together. * @see EndpointType */ public CreateServerRequest withEndpointType(EndpointType endpointType) { this.endpointType = endpointType.toString(); return this; } /** *

* 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; } /** *

* 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; } /** *

* 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. *

* 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 CreateServerRequest withHostKey(String hostKey) { setHostKey(hostKey); return this; } /** *

* * @param identityProviderDetails * Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, * Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of * the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a * customer-supplied authentication API, including the API Gateway URL. Not required when * IdentityProviderType is set to SERVICE_MANAGED. */ public void setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) { this.identityProviderDetails = identityProviderDetails; } /** *

* * @return Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, * Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of * the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a * customer-supplied authentication API, including the API Gateway URL. Not required when * IdentityProviderType is set to SERVICE_MANAGED. */ public IdentityProviderDetails getIdentityProviderDetails() { return this.identityProviderDetails; } /** *

* * @param identityProviderDetails * Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE, * Amazon Web Services_LAMBDA or API_GATEWAY. Accepts an array containing all of * the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a * customer-supplied authentication API, including the API Gateway URL. Not required when * IdentityProviderType is set to SERVICE_MANAGED. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServerRequest withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) { setIdentityProviderDetails(identityProviderDetails); return this; } /** *

* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to * store and access user credentials within the Transfer Family service. *

* * @param identityProviderType * The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows * you to store and access user credentials within the Transfer Family service.

* Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service * for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon * Web Services using AD Connector. This option also requires you to provide a Directory ID by using the * IdentityProviderDetails parameter. *

* Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you * choose this value, you must specify the ARN for the Lambda function in the Function parameter * for the IdentityProviderDetails data type. * @see IdentityProviderType */ public void setIdentityProviderType(String identityProviderType) { this.identityProviderType = identityProviderType; } /** *

* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to * store and access user credentials within the Transfer Family service. *

* * @return The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows * you to store and access user credentials within the Transfer Family service.

* Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If * you choose this value, you must specify the ARN for the Lambda function in the Function * parameter for the IdentityProviderDetails data type. * @see IdentityProviderType */ public String getIdentityProviderType() { return this.identityProviderType; } /** *

* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to * store and access user credentials within the Transfer Family service. *

* Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you * choose this value, you must specify the ARN for the Lambda function in the Function parameter * for the IdentityProviderDetails data type. * @return Returns a reference to this object so that method calls can be chained together. * @see IdentityProviderType */ public CreateServerRequest withIdentityProviderType(String identityProviderType) { setIdentityProviderType(identityProviderType); return this; } /** *

* The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to * store and access user credentials within the Transfer Family service. *

* Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you * choose this value, you must specify the ARN for the Lambda function in the Function parameter * for the IdentityProviderDetails data type. * @return Returns a reference to this object so that method calls can be chained together. * @see IdentityProviderType */ public CreateServerRequest withIdentityProviderType(IdentityProviderType identityProviderType) { this.identityProviderType = identityProviderType.toString(); return this; } /** *

* * @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; } /** *

* * @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; } /** *

* * @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 CreateServerRequest 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 CreateServerRequest 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: *

* * @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: *

* * @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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServerRequest 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 CreateServerRequest 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 CreateServerRequest 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 CreateServerRequest 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; } /** *

* 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. *
*

* 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. *
*

*
* 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. *
*

* 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. *
*

*
* 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. *
*

* Specifies the name of the security policy that is attached to the server. *

* Key-value pairs that can be used to group and search for servers. *

getTags() { return tags; } /** *

* Key-value pairs that can be used to group and search for servers. *

* * @param tags * Key-value pairs that can be used to group and search for servers. */ public void setTags(java.util.Collection tags) { if (tags == null) { this.tags = null; return; } this.tags = new java.util.ArrayList(tags); } /** *

* Key-value pairs that can be used to group and search for servers. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *

* * @param tags * Key-value pairs that can be used to group and search for servers. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServerRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList(tags.length)); } for (Tag ele : tags) { this.tags.add(ele); } return this; } /** *

* Key-value pairs that can be used to group and search for servers. *

* * @param tags * Key-value pairs that can be used to group and search for servers. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServerRequest withTags(java.util.Collection tags) { setTags(tags); return this; } /** *

* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the * workflow. *

* * @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. */ 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. *

* * @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. */ 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. *

* * @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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateServerRequest 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:* *

* 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:* *

* 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:* *

* 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:* *

* 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. *