@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() |
boolean |
equals(Object obj) |
String |
getCertificate()
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
|
EndpointDetails |
getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled
server.
|
String |
getEndpointType()
The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to.
|
String |
getHostKey()
The RSA private key as generated by the
ssh-keygen -N "" -f my-new-server-key command. |
IdentityProviderDetails |
getIdentityProviderDetails()
Required when
IdentityProviderType is set to API_GATEWAY. |
String |
getIdentityProviderType()
Specifies the mode of authentication for a file transfer protocol-enabled server.
|
String |
getLoggingRole()
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing
purposes.
|
List<String> |
getProtocols()
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
List<Tag> |
getTags()
Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
|
int |
hashCode() |
void |
setCertificate(String certificate)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
|
void |
setEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled
server.
|
void |
setEndpointType(String endpointType)
The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to.
|
void |
setHostKey(String hostKey)
The RSA private key as generated by the
ssh-keygen -N "" -f my-new-server-key command. |
void |
setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
Required when
IdentityProviderType is set to API_GATEWAY. |
void |
setIdentityProviderType(String identityProviderType)
Specifies the mode of authentication for a file transfer protocol-enabled server.
|
void |
setLoggingRole(String loggingRole)
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing
purposes.
|
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 |
setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
|
String |
toString()
Returns a string representation of this object.
|
CreateServerRequest |
withCertificate(String certificate)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
|
CreateServerRequest |
withEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled
server.
|
CreateServerRequest |
withEndpointType(EndpointType endpointType)
The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to.
|
CreateServerRequest |
withEndpointType(String endpointType)
The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to.
|
CreateServerRequest |
withHostKey(String hostKey)
The RSA private key as generated by the
ssh-keygen -N "" -f my-new-server-key command. |
CreateServerRequest |
withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
Required when
IdentityProviderType is set to API_GATEWAY. |
CreateServerRequest |
withIdentityProviderType(IdentityProviderType identityProviderType)
Specifies the mode of authentication for a file transfer protocol-enabled server.
|
CreateServerRequest |
withIdentityProviderType(String identityProviderType)
Specifies the mode of authentication for a file transfer protocol-enabled server.
|
CreateServerRequest |
withLoggingRole(String loggingRole)
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing
purposes.
|
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 |
withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
|
CreateServerRequest |
withTags(Tag... tags)
Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
|
addHandlerContext, copyBaseTo, 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, withSdkRequestTimeoutpublic void setCertificate(String certificate)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
certificate - The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.public String getCertificate()
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
Protocols is set to FTPS.public CreateServerRequest withCertificate(String certificate)
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
certificate - The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.public void setEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled 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 file transfer
protocol-enabled 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.public EndpointDetails getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled 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.
public CreateServerRequest withEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your file transfer protocol-enabled 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 file transfer
protocol-enabled 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.public void setEndpointType(String endpointType)
The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
endpointType - The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can
choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint,
you can restrict access to your server and resources only within your VPC.EndpointTypepublic String getEndpointType()
The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
EndpointTypepublic CreateServerRequest withEndpointType(String endpointType)
The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
endpointType - The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can
choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint,
you can restrict access to your server and resources only within your VPC.EndpointTypepublic CreateServerRequest withEndpointType(EndpointType endpointType)
The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
endpointType - The type of VPC endpoint that you want your file transfer protocol-enabled server to connect to. You can
choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint,
you can restrict access to your server and resources only within your VPC.EndpointTypepublic void setHostKey(String hostKey)
The RSA private key as generated by the ssh-keygen -N "" -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 Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
hostKey - The RSA private key as generated by the ssh-keygen -N "" -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 Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
public String getHostKey()
The RSA private key as generated by the ssh-keygen -N "" -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 Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
ssh-keygen -N "" -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 Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
public CreateServerRequest withHostKey(String hostKey)
The RSA private key as generated by the ssh-keygen -N "" -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 Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
hostKey - The RSA private key as generated by the ssh-keygen -N "" -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 Changing the Host Key for Your AWS Transfer Family Server in the AWS Transfer Family User Guide.
public void setIdentityProviderDetails(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.public IdentityProviderDetails getIdentityProviderDetails()
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.
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.public CreateServerRequest withIdentityProviderDetails(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.public void setIdentityProviderType(String identityProviderType)
Specifies the mode of authentication for a file transfer protocol-enabled 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 file transfer protocol-enabled 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.IdentityProviderTypepublic String getIdentityProviderType()
Specifies the mode of authentication for a file transfer protocol-enabled 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.
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.IdentityProviderTypepublic CreateServerRequest withIdentityProviderType(String identityProviderType)
Specifies the mode of authentication for a file transfer protocol-enabled 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 file transfer protocol-enabled 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.IdentityProviderTypepublic CreateServerRequest withIdentityProviderType(IdentityProviderType identityProviderType)
Specifies the mode of authentication for a file transfer protocol-enabled 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 file transfer protocol-enabled 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.IdentityProviderTypepublic void setLoggingRole(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.public String getLoggingRole()
Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
public CreateServerRequest withLoggingRole(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.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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
Protocolpublic 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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
Protocolpublic 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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
Protocolpublic 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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
Protocolpublic 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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
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:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
Protocolpublic List<Tag> getTags()
Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
public void setTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
tags - Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.public CreateServerRequest withTags(Tag... tags)
Key-value pairs that can be used to group and search for file transfer protocol-enabled 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 file transfer protocol-enabled servers.public CreateServerRequest withTags(Collection<Tag> tags)
Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.
tags - Key-value pairs that can be used to group and search for file transfer protocol-enabled servers.public String toString()
toString in class ObjectObject.toString()public CreateServerRequest clone()
clone in class AmazonWebServiceRequestCopyright © 2020. All rights reserved.