Interface CreateServerRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateServerRequest.Builder,
,CreateServerRequest> SdkBuilder<CreateServerRequest.Builder,
,CreateServerRequest> SdkPojo
,SdkRequest.Builder
,TransferRequest.Builder
- Enclosing class:
CreateServerRequest
-
Method Summary
Modifier and TypeMethodDescriptioncertificate
(String certificate) The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate.The domain of the storage system that is used for file transfers.The domain of the storage system that is used for file transfers.default CreateServerRequest.Builder
endpointDetails
(Consumer<EndpointDetails.Builder> endpointDetails) The virtual private cloud (VPC) endpoint settings that are configured for your server.endpointDetails
(EndpointDetails endpointDetails) The virtual private cloud (VPC) endpoint settings that are configured for your server.endpointType
(String endpointType) The type of endpoint that you want your server to use.endpointType
(EndpointType endpointType) The type of endpoint that you want your server to use.The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server.default CreateServerRequest.Builder
identityProviderDetails
(Consumer<IdentityProviderDetails.Builder> identityProviderDetails) Required whenIdentityProviderType
is set toAWS_DIRECTORY_SERVICE
,Amazon Web Services_LAMBDA
orAPI_GATEWAY
.identityProviderDetails
(IdentityProviderDetails identityProviderDetails) Required whenIdentityProviderType
is set toAWS_DIRECTORY_SERVICE
,Amazon Web Services_LAMBDA
orAPI_GATEWAY
.identityProviderType
(String identityProviderType) The mode of authentication for a server.identityProviderType
(IdentityProviderType identityProviderType) The mode of authentication for a server.loggingRole
(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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.postAuthenticationLoginBanner
(String postAuthenticationLoginBanner) Specifies a string to display when users connect to a server.preAuthenticationLoginBanner
(String preAuthenticationLoginBanner) Specifies a string to display when users connect to a server.default CreateServerRequest.Builder
protocolDetails
(Consumer<ProtocolDetails.Builder> protocolDetails) The protocol settings that are configured for your server.protocolDetails
(ProtocolDetails protocolDetails) The protocol settings that are configured for your server.protocols
(Collection<Protocol> protocols) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.protocolsWithStrings
(String... protocols) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.protocolsWithStrings
(Collection<String> protocols) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.default CreateServerRequest.Builder
s3StorageOptions
(Consumer<S3StorageOptions.Builder> s3StorageOptions) Specifies whether or not performance for your Amazon S3 directories is optimized.s3StorageOptions
(S3StorageOptions s3StorageOptions) Specifies whether or not performance for your Amazon S3 directories is optimized.securityPolicyName
(String securityPolicyName) Specifies the name of the security policy for the server.structuredLogDestinations
(String... structuredLogDestinations) Specifies the log groups to which your server logs are sent.structuredLogDestinations
(Collection<String> structuredLogDestinations) Specifies the log groups to which your server logs are sent.tags
(Collection<Tag> tags) Key-value pairs that can be used to group and search for servers.tags
(Consumer<Tag.Builder>... tags) Key-value pairs that can be used to group and search for servers.Key-value pairs that can be used to group and search for servers.default CreateServerRequest.Builder
workflowDetails
(Consumer<WorkflowDetails.Builder> workflowDetails) Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.workflowDetails
(WorkflowDetails workflowDetails) Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder
build
-
Method Details
-
certificate
The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required when
Protocols
is set toFTPS
.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.
- Parameters:
certificate
- The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate. Required whenProtocols
is set toFTPS
.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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
endpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
- Parameters:
endpointDetails
- The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endpointDetails
default CreateServerRequest.Builder endpointDetails(Consumer<EndpointDetails.Builder> endpointDetails) The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make 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.
This is a convenience method that creates an instance of theEndpointDetails.Builder
avoiding the need to create one manually viaEndpointDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toendpointDetails(EndpointDetails)
.- Parameters:
endpointDetails
- a consumer that will call methods onEndpointDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 withEndpointType=VPC_ENDPOINT
in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, useEndpointType
=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 theEndpointType
. 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 withEndpointType
set toVPC_ENDPOINT
.- Parameters:
endpointType
- The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT
in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers withEndpointType=VPC_ENDPOINT
in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, useEndpointType
=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 theEndpointType
. 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 withEndpointType
set toVPC_ENDPOINT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 withEndpointType=VPC_ENDPOINT
in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, useEndpointType
=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 theEndpointType
. 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 withEndpointType
set toVPC_ENDPOINT
.- Parameters:
endpointType
- The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT
in your Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already created servers withEndpointType=VPC_ENDPOINT
in your Amazon Web Services account on or before May 19, 2021, you will not be affected. After this date, useEndpointType
=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 theEndpointType
. 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 withEndpointType
set toVPC_ENDPOINT
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
hostKey
The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.Use a minimum value of 2048 for the
-b
option. You can create a stronger key by using 3072 or 4096.Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.Valid values for the
-b
option for ECDSA are 256, 384, and 521.Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.
- Parameters:
hostKey
- The RSA, ECDSA, or ED25519 private key to use for your SFTP-enabled server. You can add multiple host keys, in case you want to rotate keys, or have a set of active keys that use different algorithms.Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key
.Use a minimum value of 2048 for the
-b
option. You can create a stronger key by using 3072 or 4096.Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key
.Valid values for the
-b
option for ECDSA are 256, 384, and 521.Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key
.For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Manage host keys for your SFTP-enabled server in the Transfer Family User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
identityProviderDetails
CreateServerRequest.Builder identityProviderDetails(IdentityProviderDetails identityProviderDetails) Required when
IdentityProviderType
is set toAWS_DIRECTORY_SERVICE
,Amazon Web Services_LAMBDA
orAPI_GATEWAY
. Accepts an array containing all of the information required to use a directory inAWS_DIRECTORY_SERVICE
or invoke a customer-supplied authentication API, including the API Gateway URL. Not required whenIdentityProviderType
is set toSERVICE_MANAGED
.- Parameters:
identityProviderDetails
- Required whenIdentityProviderType
is set toAWS_DIRECTORY_SERVICE
,Amazon Web Services_LAMBDA
orAPI_GATEWAY
. Accepts an array containing all of the information required to use a directory inAWS_DIRECTORY_SERVICE
or invoke a customer-supplied authentication API, including the API Gateway URL. Not required whenIdentityProviderType
is set toSERVICE_MANAGED
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
identityProviderDetails
default CreateServerRequest.Builder identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails) Required when
This is a convenience method that creates an instance of theIdentityProviderType
is set toAWS_DIRECTORY_SERVICE
,Amazon Web Services_LAMBDA
orAPI_GATEWAY
. Accepts an array containing all of the information required to use a directory inAWS_DIRECTORY_SERVICE
or invoke a customer-supplied authentication API, including the API Gateway URL. Not required whenIdentityProviderType
is set toSERVICE_MANAGED
.IdentityProviderDetails.Builder
avoiding the need to create one manually viaIdentityProviderDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toidentityProviderDetails(IdentityProviderDetails)
.- Parameters:
identityProviderDetails
- a consumer that will call methods onIdentityProviderDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- Parameters:
identityProviderType
- The mode of authentication for a server. The default value isSERVICE_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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- Parameters:
identityProviderType
- The mode of authentication for a server. The default value isSERVICE_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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
loggingRole
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
- Parameters:
loggingRole
- The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
postAuthenticationLoginBanner
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
- Parameters:
postAuthenticationLoginBanner
- Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.The SFTP protocol does not support post-authentication display banners.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
preAuthenticationLoginBanner
Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
- Parameters:
preAuthenticationLoginBanner
- Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocolsWithStrings
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 eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
- Parameters:
protocols
- Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:-
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH -
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption -
FTP
(File Transfer Protocol): Unencrypted file transfer -
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
-
If you select
FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. -
If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
protocolsWithStrings
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 eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
- Parameters:
protocols
- Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:-
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH -
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption -
FTP
(File Transfer Protocol): Unencrypted file transfer -
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
-
If you select
FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. -
If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
- Parameters:
protocols
- Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:-
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH -
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption -
FTP
(File Transfer Protocol): Unencrypted file transfer -
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
-
If you select
FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. -
If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
- Parameters:
protocols
- Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:-
SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH -
FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption -
FTP
(File Transfer Protocol): Unencrypted file transfer -
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
-
If you select
FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. -
If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 theSetStatOption
parameter. To have the Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
call. -
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
TlsSessionResumptionMode
parameter. -
As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
- Parameters:
protocolDetails
- The protocol settings that are configured for your server.-
To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIp
parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. -
To ignore the error that is generated when the client attempts to use the
SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use theSetStatOption
parameter. To have the Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
call. -
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
TlsSessionResumptionMode
parameter. -
As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
protocolDetails
default CreateServerRequest.Builder protocolDetails(Consumer<ProtocolDetails.Builder> 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 theSetStatOption
parameter. To have the Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
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.Builder
avoiding the need to create one manually viaProtocolDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprotocolDetails(ProtocolDetails)
.- Parameters:
protocolDetails
- a consumer that will call methods onProtocolDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
securityPolicyName
Specifies the name of the security policy for the server.
- Parameters:
securityPolicyName
- Specifies the name of the security policy for the server.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Key-value pairs that can be used to group and search for servers.
- Parameters:
tags
- Key-value pairs that can be used to group and search for servers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Key-value pairs that can be used to group and search for servers.
- Parameters:
tags
- Key-value pairs that can be used to group and search for servers.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Key-value pairs that can be used to group and search for servers.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
workflowDetails
- Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.In addition to a workflow to execute when a file is uploaded completely,
WorkflowDetails
can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workflowDetails
default CreateServerRequest.Builder workflowDetails(Consumer<WorkflowDetails.Builder> 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,
This is a convenience method that creates an instance of theWorkflowDetails
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.Builder
avoiding the need to create one manually viaWorkflowDetails.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkflowDetails(WorkflowDetails)
.- Parameters:
workflowDetails
- a consumer that will call methods onWorkflowDetails.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
structuredLogDestinations
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example,
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an
update-server
call. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
- Parameters:
structuredLogDestinations
- Specifies the log groups to which your server logs are sent.To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example,
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an
update-server
call. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
structuredLogDestinations
Specifies the log groups to which your server logs are sent.
To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example,
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an
update-server
call. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
- Parameters:
structuredLogDestinations
- Specifies the log groups to which your server logs are sent.To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example,
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an
update-server
call. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
ofDIRECTORY
. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntry
Type
toFILE
if you want a mapping to have a file target.- Parameters:
s3StorageOptions
- Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.By default, home directory mappings have a
TYPE
ofDIRECTORY
. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntry
Type
toFILE
if you want a mapping to have a file target.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
s3StorageOptions
default CreateServerRequest.Builder s3StorageOptions(Consumer<S3StorageOptions.Builder> 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
This is a convenience method that creates an instance of theTYPE
ofDIRECTORY
. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntry
Type
toFILE
if you want a mapping to have a file target.S3StorageOptions.Builder
avoiding the need to create one manually viaS3StorageOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tos3StorageOptions(S3StorageOptions)
.- Parameters:
s3StorageOptions
- a consumer that will call methods onS3StorageOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-