public static interface CreateServerRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateServerRequest.Builder |
certificate(String certificate)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
|
default CreateServerRequest.Builder |
endpointDetails(Consumer<EndpointDetails.Builder> endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
CreateServerRequest.Builder |
endpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
CreateServerRequest.Builder |
endpointType(EndpointType endpointType)
The type of VPC endpoint that you want your server to connect to.
|
CreateServerRequest.Builder |
endpointType(String endpointType)
The type of VPC endpoint that you want your server to connect to.
|
CreateServerRequest.Builder |
hostKey(String hostKey)
The RSA private key as generated by the
ssh-keygen -N "" -m PEM -f my-new-server-key command. |
default CreateServerRequest.Builder |
identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)
Required when
IdentityProviderType is set to API_GATEWAY. |
CreateServerRequest.Builder |
identityProviderDetails(IdentityProviderDetails identityProviderDetails)
Required when
IdentityProviderType is set to API_GATEWAY. |
CreateServerRequest.Builder |
identityProviderType(IdentityProviderType identityProviderType)
Specifies the mode of authentication for a server.
|
CreateServerRequest.Builder |
identityProviderType(String identityProviderType)
Specifies the mode of authentication for a server.
|
CreateServerRequest.Builder |
loggingRole(String loggingRole)
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing
purposes.
|
CreateServerRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateServerRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateServerRequest.Builder |
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.
|
CreateServerRequest.Builder |
protocols(Protocol... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
CreateServerRequest.Builder |
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.
|
CreateServerRequest.Builder |
protocolsWithStrings(String... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
CreateServerRequest.Builder |
securityPolicyName(String securityPolicyName)
Specifies the name of the security policy that is attached to the server.
|
CreateServerRequest.Builder |
tags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for servers.
|
CreateServerRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Key-value pairs that can be used to group and search for servers.
|
CreateServerRequest.Builder |
tags(Tag... tags)
Key-value pairs that can be used to group and search for servers.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateServerRequest.Builder certificate(String certificate)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS 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 AWS Certificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS 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.
CreateServerRequest.Builder endpointDetails(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 it accessible only to resources within your VPC, or you can attach Elastic IPs and make it 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 it accessible only to resources within your VPC, or you
can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default
security groups are automatically assigned to your endpoint.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 it accessible only to resources within your VPC, or you can attach Elastic IPs and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
This is a convenience that creates an instance of theEndpointDetails.Builder avoiding the need to
create one manually via EndpointDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to endpointDetails(EndpointDetails).endpointDetails - a consumer that will call methods on EndpointDetails.BuilderendpointDetails(EndpointDetails)CreateServerRequest.Builder endpointType(String endpointType)
The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
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 VPC endpoint that you want your server to connect to. You can choose to connect to the
public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and
resources only within your VPC.
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,
EndpointTypeCreateServerRequest.Builder endpointType(EndpointType endpointType)
The type of VPC endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
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 VPC endpoint that you want your server to connect to. You can choose to connect to the
public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and
resources only within your VPC.
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,
EndpointTypeCreateServerRequest.Builder hostKey(String hostKey)
The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key command.
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 Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.
hostKey - The RSA private key as generated by the ssh-keygen -N "" -m PEM -f my-new-server-key
command. 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 Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.
CreateServerRequest.Builder identityProviderDetails(IdentityProviderDetails identityProviderDetails)
Required when IdentityProviderType is set to API_GATEWAY. Accepts an array
containing all of the information required to call 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 API_GATEWAY. Accepts an array
containing all of the information required to call a customer-supplied authentication API, including
the API Gateway URL. Not required when IdentityProviderType is set to
SERVICE_MANAGED.default CreateServerRequest.Builder identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)
Required when IdentityProviderType is set to API_GATEWAY. Accepts an array
containing all of the information required to call a customer-supplied authentication API, including the API
Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
IdentityProviderDetails.Builder avoiding the
need to create one manually via IdentityProviderDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to identityProviderDetails(IdentityProviderDetails).identityProviderDetails - a consumer that will call methods on IdentityProviderDetails.BuilderidentityProviderDetails(IdentityProviderDetails)CreateServerRequest.Builder identityProviderType(String identityProviderType)
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which
allows you to store and access user credentials within the AWS Transfer Family service. Use the
API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for
authentication using the IdentityProviderDetails parameter.
identityProviderType - Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED,
which allows you to store and access user credentials within the AWS Transfer Family service. Use the
API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for
authentication using the IdentityProviderDetails parameter.IdentityProviderType,
IdentityProviderTypeCreateServerRequest.Builder identityProviderType(IdentityProviderType identityProviderType)
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which
allows you to store and access user credentials within the AWS Transfer Family service. Use the
API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for
authentication using the IdentityProviderDetails parameter.
identityProviderType - Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED,
which allows you to store and access user credentials within the AWS Transfer Family service. Use the
API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for
authentication using the IdentityProviderDetails parameter.IdentityProviderType,
IdentityProviderTypeCreateServerRequest.Builder loggingRole(String loggingRole)
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
loggingRole - Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and
auditing purposes.CreateServerRequest.Builder 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. 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
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which
will be 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
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 to SERVICE_MANAGED.
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
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM)
which will be 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
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 to
SERVICE_MANAGED.
CreateServerRequest.Builder protocolsWithStrings(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
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which
will be 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
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 to SERVICE_MANAGED.
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
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM)
which will be 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
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 to
SERVICE_MANAGED.
CreateServerRequest.Builder 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. 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
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which
will be 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
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 to SERVICE_MANAGED.
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
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM)
which will be 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
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 to
SERVICE_MANAGED.
CreateServerRequest.Builder protocols(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
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which
will be 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
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 to SERVICE_MANAGED.
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
If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM)
which will be 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
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 to
SERVICE_MANAGED.
CreateServerRequest.Builder securityPolicyName(String securityPolicyName)
Specifies the name of the security policy that is attached to the server.
securityPolicyName - Specifies the name of the security policy that is attached to the server.CreateServerRequest.Builder tags(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.CreateServerRequest.Builder tags(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.CreateServerRequest.Builder tags(Consumer<Tag.Builder>... tags)
Key-value pairs that can be used to group and search for servers.
This is a convenience that creates an instance of theList.Builder avoiding the need to create
one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) CreateServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2020. All rights reserved.