@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateServerRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateServerRequest() |
Modifier and Type | Method and Description |
---|---|
CreateServerRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getCertificate()
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate.
|
String |
getDomain()
The domain of the storage system that is used for file transfers.
|
EndpointDetails |
getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
String |
getEndpointType()
The type of endpoint that you want your server to use.
|
String |
getHostKey()
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
|
IdentityProviderDetails |
getIdentityProviderDetails()
Required when
IdentityProviderType is set to AWS_DIRECTORY_SERVICE ,
Amazon Web Services_LAMBDA or API_GATEWAY . |
String |
getIdentityProviderType()
The mode of authentication for a server.
|
String |
getLoggingRole()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on
Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
|
String |
getPostAuthenticationLoginBanner()
Specifies a string to display when users connect to a server.
|
String |
getPreAuthenticationLoginBanner()
Specifies a string to display when users connect to a server.
|
ProtocolDetails |
getProtocolDetails()
The protocol settings that are configured for your server.
|
List<String> |
getProtocols()
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
S3StorageOptions |
getS3StorageOptions()
Specifies whether or not performance for your Amazon S3 directories is optimized.
|
String |
getSecurityPolicyName()
Specifies the name of the security policy for the server.
|
List<String> |
getStructuredLogDestinations()
Specifies the log groups to which your server logs are sent.
|
List<Tag> |
getTags()
Key-value pairs that can be used to group and search for servers.
|
WorkflowDetails |
getWorkflowDetails()
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
int |
hashCode() |
void |
setCertificate(String certificate)
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate.
|
void |
setDomain(String domain)
The domain of the storage system that is used for file transfers.
|
void |
setEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
void |
setEndpointType(String endpointType)
The type of endpoint that you want your server to use.
|
void |
setHostKey(String hostKey)
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
|
void |
setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
Required when
IdentityProviderType is set to AWS_DIRECTORY_SERVICE ,
Amazon Web Services_LAMBDA or API_GATEWAY . |
void |
setIdentityProviderType(String identityProviderType)
The mode of authentication for a server.
|
void |
setLoggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on
Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
|
void |
setPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
void |
setPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
void |
setProtocolDetails(ProtocolDetails protocolDetails)
The protocol settings that are configured for your server.
|
void |
setProtocols(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
void |
setS3StorageOptions(S3StorageOptions s3StorageOptions)
Specifies whether or not performance for your Amazon S3 directories is optimized.
|
void |
setSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the server.
|
void |
setStructuredLogDestinations(Collection<String> structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
void |
setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
|
void |
setWorkflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
String |
toString()
Returns a string representation of this object.
|
CreateServerRequest |
withCertificate(String certificate)
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate.
|
CreateServerRequest |
withDomain(Domain domain)
The domain of the storage system that is used for file transfers.
|
CreateServerRequest |
withDomain(String domain)
The domain of the storage system that is used for file transfers.
|
CreateServerRequest |
withEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
CreateServerRequest |
withEndpointType(EndpointType endpointType)
The type of endpoint that you want your server to use.
|
CreateServerRequest |
withEndpointType(String endpointType)
The type of endpoint that you want your server to use.
|
CreateServerRequest |
withHostKey(String hostKey)
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.
|
CreateServerRequest |
withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
Required when
IdentityProviderType is set to AWS_DIRECTORY_SERVICE ,
Amazon Web Services_LAMBDA or API_GATEWAY . |
CreateServerRequest |
withIdentityProviderType(IdentityProviderType identityProviderType)
The mode of authentication for a server.
|
CreateServerRequest |
withIdentityProviderType(String identityProviderType)
The mode of authentication for a server.
|
CreateServerRequest |
withLoggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on
Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
|
CreateServerRequest |
withPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
CreateServerRequest |
withPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
CreateServerRequest |
withProtocolDetails(ProtocolDetails protocolDetails)
The protocol settings that are configured for your server.
|
CreateServerRequest |
withProtocols(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
CreateServerRequest |
withProtocols(Protocol... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
CreateServerRequest |
withProtocols(String... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
CreateServerRequest |
withS3StorageOptions(S3StorageOptions s3StorageOptions)
Specifies whether or not performance for your Amazon S3 directories is optimized.
|
CreateServerRequest |
withSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the server.
|
CreateServerRequest |
withStructuredLogDestinations(Collection<String> structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
CreateServerRequest |
withStructuredLogDestinations(String... structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
CreateServerRequest |
withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
|
CreateServerRequest |
withTags(Tag... tags)
Key-value pairs that can be used to group and search for servers.
|
CreateServerRequest |
withWorkflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setCertificate(String 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.
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 String getCertificate()
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.
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 CreateServerRequest withCertificate(String 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.
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 setDomain(String 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.
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.
Domain
public String getDomain()
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.
After the server is created, the domain cannot be changed.
Domain
public CreateServerRequest withDomain(String 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.
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.
Domain
public CreateServerRequest withDomain(Domain 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.
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.
Domain
public void setEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
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 EndpointDetails getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
public CreateServerRequest withEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
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 setEndpointType(String endpointType)
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
in your
Amazon Web 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
.
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
.
EndpointType
public String getEndpointType()
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
in your
Amazon Web 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
.
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
.
EndpointType
public CreateServerRequest withEndpointType(String endpointType)
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
in your
Amazon Web 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
.
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
.
EndpointType
public CreateServerRequest withEndpointType(EndpointType endpointType)
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT
in your
Amazon Web 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
.
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
.
EndpointType
public void setHostKey(String hostKey)
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.
Use a minimum value of 2048 for the -b
option. You can create a stronger key by using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.
Valid values for the -b
option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.
For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.
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 String getHostKey()
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.
Use a minimum value of 2048 for the -b
option. You can create a stronger key by using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.
Valid values for the -b
option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.
For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.
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 CreateServerRequest withHostKey(String hostKey)
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.
Use a minimum value of 2048 for the -b
option. You can create a stronger key by using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.
Valid values for the -b
option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.
For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.
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 setIdentityProviderDetails(IdentityProviderDetails 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
.
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 IdentityProviderDetails getIdentityProviderDetails()
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
.
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 CreateServerRequest withIdentityProviderDetails(IdentityProviderDetails 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
.
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 setIdentityProviderType(String 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 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.
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 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.
IdentityProviderType
public String getIdentityProviderType()
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.
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.
IdentityProviderType
public CreateServerRequest withIdentityProviderType(String 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 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.
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 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.
IdentityProviderType
public CreateServerRequest withIdentityProviderType(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.
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.
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 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.
IdentityProviderType
public void setLoggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
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 String getLoggingRole()
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
public CreateServerRequest withLoggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
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 setPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
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 String getPostAuthenticationLoginBanner()
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
The SFTP protocol does not support post-authentication display banners.
public CreateServerRequest withPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
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 setPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
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 String getPreAuthenticationLoginBanner()
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
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 CreateServerRequest withPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
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 List<String> getProtocols()
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
FTP
(File Transfer Protocol): Unencrypted file transfer
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used
to identify your server when clients connect to it over FTPS.
If Protocol
includes either FTP
or FTPS
, then the
EndpointType
must be VPC
and the IdentityProviderType
must be either
AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or API_GATEWAY
.
If Protocol
includes FTP
, then AddressAllocationIds
cannot be associated.
If Protocol
is set only to SFTP
, the EndpointType
can be set to
PUBLIC
and the IdentityProviderType
can be set any of the supported identity types:
SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
API_GATEWAY
.
If Protocol
includes AS2
, then the EndpointType
must be VPC
,
and domain must be Amazon S3.
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.
Protocol
public void setProtocols(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
FTP
(File Transfer Protocol): Unencrypted file transfer
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used
to identify your server when clients connect to it over FTPS.
If Protocol
includes either FTP
or FTPS
, then the
EndpointType
must be VPC
and the IdentityProviderType
must be either
AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or API_GATEWAY
.
If Protocol
includes FTP
, then AddressAllocationIds
cannot be associated.
If Protocol
is set only to SFTP
, the EndpointType
can be set to
PUBLIC
and the IdentityProviderType
can be set any of the supported identity types:
SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
API_GATEWAY
.
If Protocol
includes AS2
, then the EndpointType
must be VPC
,
and domain must be Amazon S3.
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.
Protocol
public CreateServerRequest withProtocols(String... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
FTP
(File Transfer Protocol): Unencrypted file transfer
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used
to identify your server when clients connect to it over FTPS.
If Protocol
includes either FTP
or FTPS
, then the
EndpointType
must be VPC
and the IdentityProviderType
must be either
AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or API_GATEWAY
.
If Protocol
includes FTP
, then AddressAllocationIds
cannot be associated.
If Protocol
is set only to SFTP
, the EndpointType
can be set to
PUBLIC
and the IdentityProviderType
can be set any of the supported identity types:
SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
API_GATEWAY
.
If Protocol
includes AS2
, then the EndpointType
must be VPC
,
and domain must be Amazon S3.
NOTE: This method appends the values to the existing list (if any). Use
setProtocols(java.util.Collection)
or withProtocols(java.util.Collection)
if you want to
override the existing values.
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.
Protocol
public CreateServerRequest withProtocols(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
FTP
(File Transfer Protocol): Unencrypted file transfer
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used
to identify your server when clients connect to it over FTPS.
If Protocol
includes either FTP
or FTPS
, then the
EndpointType
must be VPC
and the IdentityProviderType
must be either
AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or API_GATEWAY
.
If Protocol
includes FTP
, then AddressAllocationIds
cannot be associated.
If Protocol
is set only to SFTP
, the EndpointType
can be set to
PUBLIC
and the IdentityProviderType
can be set any of the supported identity types:
SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
API_GATEWAY
.
If Protocol
includes AS2
, then the EndpointType
must be VPC
,
and domain must be Amazon S3.
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.
Protocol
public CreateServerRequest withProtocols(Protocol... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
FTP
(File Transfer Protocol): Unencrypted file transfer
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used
to identify your server when clients connect to it over FTPS.
If Protocol
includes either FTP
or FTPS
, then the
EndpointType
must be VPC
and the IdentityProviderType
must be either
AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or API_GATEWAY
.
If Protocol
includes FTP
, then AddressAllocationIds
cannot be associated.
If Protocol
is set only to SFTP
, the EndpointType
can be set to
PUBLIC
and the IdentityProviderType
can be set any of the supported identity types:
SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
API_GATEWAY
.
If Protocol
includes AS2
, then the EndpointType
must be VPC
,
and domain must be Amazon S3.
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.
Protocol
public void setProtocolDetails(ProtocolDetails protocolDetails)
The protocol settings that are configured for your server.
To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a single
dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
To ignore the error that is generated when the client attempts to use the SETSTAT
command on a file
that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the Transfer
Family server ignore the SETSTAT
command and upload files without needing to make any changes to
your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter
to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can
determine when the client is making a SETSTAT
call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID,
use the TlsSessionResumptionMode
parameter.
As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
supported.
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 ProtocolDetails getProtocolDetails()
The protocol settings that are configured for your server.
To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a single
dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
To ignore the error that is generated when the client attempts to use the SETSTAT
command on a file
that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the Transfer
Family server ignore the SETSTAT
command and upload files without needing to make any changes to
your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter
to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can
determine when the client is making a SETSTAT
call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID,
use the TlsSessionResumptionMode
parameter.
As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
supported.
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 CreateServerRequest withProtocolDetails(ProtocolDetails protocolDetails)
The protocol settings that are configured for your server.
To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a single
dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
To ignore the error that is generated when the client attempts to use the SETSTAT
command on a file
that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the Transfer
Family server ignore the SETSTAT
command and upload files without needing to make any changes to
your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter
to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can
determine when the client is making a SETSTAT
call.
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID,
use the TlsSessionResumptionMode
parameter.
As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
supported.
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 setSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the server.
securityPolicyName
- Specifies the name of the security policy for the server.public String getSecurityPolicyName()
Specifies the name of the security policy for the server.
public CreateServerRequest withSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the server.
securityPolicyName
- Specifies the name of the security policy for the server.public List<Tag> getTags()
Key-value pairs that can be used to group and search for servers.
public void setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
tags
- Key-value pairs that can be used to group and search for servers.public CreateServerRequest withTags(Tag... 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
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Key-value pairs that can be used to group and search for servers.public CreateServerRequest withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
tags
- Key-value pairs that can be used to group and search for servers.public void setWorkflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also
contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs
when the server session disconnects while the file is still being uploaded.
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 WorkflowDetails getWorkflowDetails()
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also
contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs
when the server session disconnects while the file is still being uploaded.
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 CreateServerRequest withWorkflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also
contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs
when the server session disconnects while the file is still being uploaded.
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 List<String> getStructuredLogDestinations()
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
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(Collection<String> structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
structuredLogDestinations
- Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off
structured logging, by providing an empty value for this parameter in an update-server
call.
For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
public CreateServerRequest withStructuredLogDestinations(String... structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
NOTE: This method appends the values to the existing list (if any). Use
setStructuredLogDestinations(java.util.Collection)
or
withStructuredLogDestinations(java.util.Collection)
if you want to override the existing values.
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 CreateServerRequest withStructuredLogDestinations(Collection<String> structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
logging, by providing an empty value for this parameter in an update-server
call. For example:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
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 setS3StorageOptions(S3StorageOptions s3StorageOptions)
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this
option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to
FILE
if you want a mapping to have a file target.
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 S3StorageOptions getS3StorageOptions()
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this
option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to
FILE
if you want a mapping to have a file target.
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 CreateServerRequest withS3StorageOptions(S3StorageOptions s3StorageOptions)
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this
option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to
FILE
if you want a mapping to have a file target.
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 String toString()
toString
in class Object
Object.toString()
public CreateServerRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()