CreateServerRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.transfer.model.TransferRequest
    - - software.amazon.awssdk.services.transfer.model.CreateServerRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateServerRequest
extends TransferRequest
implements ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateServerRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateServerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateServerRequest.Builder`	`builder()`
`String`	`certificate()` The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
`Domain`	`domain()` The domain of the storage system that is used for file transfers.
`String`	`domainAsString()` The domain of the storage system that is used for file transfers.
`EndpointDetails`	`endpointDetails()` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`EndpointType`	`endpointType()` The type of endpoint that you want your server to use.
`String`	`endpointTypeAsString()` The type of endpoint that you want your server to use.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasProtocols()` Returns true if the Protocols property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`hostKey()` The RSA private key as generated by the `ssh-keygen -N "" -m PEM -f my-new-server-key` command.
`IdentityProviderDetails`	`identityProviderDetails()` Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY`.
`IdentityProviderType`	`identityProviderType()` Specifies the mode of authentication for a server.
`String`	`identityProviderTypeAsString()` Specifies the mode of authentication for a server.
`String`	`loggingRole()` Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
`List<Protocol>`	`protocols()` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`List<String>`	`protocolsAsStrings()` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityPolicyName()` Specifies the name of the security policy that is attached to the server.
`static Class<? extends CreateServerRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Key-value pairs that can be used to group and search for servers.
`CreateServerRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - certificate
```
public final 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.
    Returns:
    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.
  - domain
```
public final Domain domain()
```
    The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
    
    After the server is created, the domain cannot be changed.
    
    If the service returns an enum value that is not available in the current SDK version, domain will return Domain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().
    
    Returns:
    
    The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
    
    After the server is created, the domain cannot be changed.
    
    See Also:
    
    Domain
  - domainAsString
```
public final String domainAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, domain will return Domain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainAsString().
    
    Returns:
    
    The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
    
    After the server is created, the domain cannot be changed.
    
    See Also:
    
    Domain
  - endpointDetails
```
public final 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 IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
    
    Returns:
    
    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 IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
  - endpointType
```
public final EndpointType endpointType()
```
    The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
    
    After March 31, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before March 31, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before March 31, 2021, you will not be affected. After this date, use EndpointType=VPC.
    
    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
    
    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
    
    If the service returns an enum value that is not available in the current SDK version, endpointType will return EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().
    
    Returns:
    
    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 March 31, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before March 31, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before March 31, 2021, you will not be affected. After this date, use EndpointType=VPC.
    
    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
    
    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
    
    See Also:
    
    EndpointType
  - endpointTypeAsString
```
public final String endpointTypeAsString()
```
    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 March 31, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before March 31, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before March 31, 2021, you will not be affected. After this date, use EndpointType=VPC.
    
    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
    
    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
    
    If the service returns an enum value that is not available in the current SDK version, endpointType will return EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().
    
    Returns:
    
    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 March 31, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your AWS account if your account hasn't already done so before March 31, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your AWS account on or before March 31, 2021, you will not be affected. After this date, use EndpointType=VPC.
    
    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
    
    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
    
    See Also:
    
    EndpointType
  - hostKey
```
public final 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.
    
    Returns:
    
    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.
  - identityProviderDetails
```
public final IdentityProviderDetails identityProviderDetails()
```
    Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
    
    Returns:
    
    Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or API_GATEWAY. Accepts an array containing all of the information required to use a directory in AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
  - identityProviderType
```
public final 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 AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
    
    If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().
    
    Returns:
    
    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 AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
    
    See Also:
    
    IdentityProviderType
  - identityProviderTypeAsString
```
public final String identityProviderTypeAsString()
```
    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 AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
    
    If the service returns an enum value that is not available in the current SDK version, identityProviderType will return IdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityProviderTypeAsString().
    
    Returns:
    
    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 AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in AWS Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. This option also requires you to provide a Directory ID using the IdentityProviderDetails parameter. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.
    
    See Also:
    
    IdentityProviderType
  - loggingRole
```
public final String loggingRole()
```
    Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
    
    Returns:
    
    Allows the service to write your users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.
  - protocols
```
public final List<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 AWS_DIRECTORY_SERVICE or API_GATEWAY.
    
    If Protocol includes FTP, then AddressAllocationIds cannot be associated.
    
    If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasProtocols() to see if a value was sent in this field.
    Returns:
    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 AWS_DIRECTORY_SERVICE or API_GATEWAY.
    
    If Protocol includes FTP, then AddressAllocationIds cannot be associated.
    
    If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
  - hasProtocols
```
public final boolean hasProtocols()
```
    Returns true if the Protocols property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - protocolsAsStrings
```
public final List<String> protocolsAsStrings()
```
    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 AWS_DIRECTORY_SERVICE or API_GATEWAY.
    
    If Protocol includes FTP, then AddressAllocationIds cannot be associated.
    
    If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasProtocols() to see if a value was sent in this field.
    Returns:
    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 AWS_DIRECTORY_SERVICE or API_GATEWAY.
    
    If Protocol includes FTP, then AddressAllocationIds cannot be associated.
    
    If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
  - securityPolicyName
```
public final String securityPolicyName()
```
    Specifies the name of the security policy that is attached to the server.
    
    Returns:
    
    Specifies the name of the security policy that is attached to the server.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tags
```
public final List<Tag> tags()
```
    Key-value pairs that can be used to group and search for servers.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Key-value pairs that can be used to group and search for servers.
  - toBuilder
```
public CreateServerRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateServerRequest.Builder,CreateServerRequest>
    
    Specified by:
    
    toBuilder in class TransferRequest
  - builder
```
public static CreateServerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateServerRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateServerRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

certificate

domain

domainAsString

endpointDetails

endpointType

endpointTypeAsString

hostKey

identityProviderDetails

identityProviderType

identityProviderTypeAsString

loggingRole

protocols

hasProtocols

protocolsAsStrings

securityPolicyName

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields