Interface DescribedServer.Builder

All Superinterfaces:
Buildable, CopyableBuilder<DescribedServer.Builder,DescribedServer>, SdkBuilder<DescribedServer.Builder,DescribedServer>, SdkPojo
Enclosing class:
DescribedServer
public static interface DescribedServer.Builder extends SdkPojo, CopyableBuilder<DescribedServer.Builder,DescribedServer>

  • Method Details

    • arn

      DescribedServer.Builder arn(String arn)

      Specifies the unique Amazon Resource Name (ARN) of the server.

      Parameters:
      arn - Specifies the unique Amazon Resource Name (ARN) of the server.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificate

      DescribedServer.Builder certificate(String certificate)

      Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

      Parameters:
      certificate - Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocolDetails

      DescribedServer.Builder protocolDetails(ProtocolDetails protocolDetails)

      The protocol settings that are configured for your server.

      • To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.

      • To ignore the error that is generated when the client attempts to use the SETSTAT command on a file that you are uploading to an Amazon S3 bucket, use the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

      • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

      • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

      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 the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

      • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

      • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocolDetails

      default DescribedServer.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 the SetStatOption parameter. To have the Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP. If you set the SetStatOption parameter to ENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT call.

      • To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the TlsSessionResumptionMode parameter.

      • As2Transports indicates the transport method for the AS2 messages. Currently, only HTTP is supported.

      This is a convenience method that creates an instance of the ProtocolDetails.Builder avoiding the need to create one manually via ProtocolDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to protocolDetails(ProtocolDetails).

      Parameters:
      protocolDetails - a consumer that will call methods on ProtocolDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • domain

      DescribedServer.Builder domain(String domain)

      Specifies 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.

      Parameters:
      domain - Specifies 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • domain

      DescribedServer.Builder domain(Domain domain)

      Specifies 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.

      Parameters:
      domain - Specifies 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endpointDetails

      DescribedServer.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 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 DescribedServer.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 the EndpointDetails.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).

      Parameters:
      endpointDetails - a consumer that will call methods on EndpointDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endpointType

      DescribedServer.Builder endpointType(String endpointType)

      Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

      Parameters:
      endpointType - Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endpointType

      DescribedServer.Builder endpointType(EndpointType endpointType)

      Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.

      Parameters:
      endpointType - Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hostKeyFingerprint

      DescribedServer.Builder hostKeyFingerprint(String hostKeyFingerprint)

      Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.

      Parameters:
      hostKeyFingerprint - Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output of the ssh-keygen -l -f my-new-server-key command.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderDetails

      DescribedServer.Builder identityProviderDetails(IdentityProviderDetails identityProviderDetails)

      Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.

      Parameters:
      identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityProviderDetails

      default DescribedServer.Builder identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)

      Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or SERVICE_MANAGED.

      This is a convenience method that creates an instance of the 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).

      Parameters:
      identityProviderDetails - a consumer that will call methods on IdentityProviderDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • identityProviderType

      DescribedServer.Builder identityProviderType(String identityProviderType)

      The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

      Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

      Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

      Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

      Parameters:
      identityProviderType - The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

      Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

      Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

      Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • identityProviderType

      DescribedServer.Builder identityProviderType(IdentityProviderType identityProviderType)

      The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

      Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

      Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

      Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

      Parameters:
      identityProviderType - The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you to store and access user credentials within the Transfer Family service.

      Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services using AD Connector. This option also requires you to provide a Directory ID by using the IdentityProviderDetails parameter.

      Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails parameter.

      Use the AWS_LAMBDA value to directly use an Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in the Function parameter for the IdentityProviderDetails data type.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • loggingRole

      DescribedServer.Builder 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. 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

      DescribedServer.Builder postAuthenticationLoginBanner(String postAuthenticationLoginBanner)

      Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.

      The SFTP protocol does not support post-authentication display banners.

      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

      DescribedServer.Builder preAuthenticationLoginBanner(String preAuthenticationLoginBanner)

      Specifies a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system:

      This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.

      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

      DescribedServer.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

      • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

      • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

      • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

      • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

      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 either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

      • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocolsWithStrings

      DescribedServer.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

      • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

      • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

      • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

      • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

      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 either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

      • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocols

      DescribedServer.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

      • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

      • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

      • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

      • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

      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 either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

      • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • protocols

      DescribedServer.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

      • AS2 (Applicability Statement 2): used for transporting structured business-to-business data

      • If you select FTPS, you must choose a certificate stored in Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS.

      • If Protocol includes either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

      • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

      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 either FTP or FTPS, then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes FTP, then AddressAllocationIds cannot be associated.

      • If Protocol is set only to SFTP, the EndpointType can be set to PUBLIC and the IdentityProviderType can be set any of the supported identity types: SERVICE_MANAGED, AWS_DIRECTORY_SERVICE, AWS_LAMBDA, or API_GATEWAY.

      • If Protocol includes AS2, then the EndpointType must be VPC, and domain must be Amazon S3.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • securityPolicyName

      DescribedServer.Builder securityPolicyName(String 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.

    • serverId

      DescribedServer.Builder serverId(String serverId)

      Specifies the unique system-assigned identifier for a server that you instantiate.

      Parameters:
      serverId - Specifies the unique system-assigned identifier for a server that you instantiate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      DescribedServer.Builder state(String state)

      The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

      The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

      Parameters:
      state - The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

      The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      DescribedServer.Builder state(State state)

      The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

      The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

      Parameters:
      state - The condition of the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

      The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      DescribedServer.Builder tags(Collection<Tag> tags)

      Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

      Parameters:
      tags - Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribedServer.Builder tags(Tag... tags)

      Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

      Parameters:
      tags - Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      DescribedServer.Builder tags(Consumer<Tag.Builder>... tags)

      Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userCount

      DescribedServer.Builder userCount(Integer userCount)

      Specifies the number of users that are assigned to a server you specified with the ServerId.

      Parameters:
      userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowDetails

      DescribedServer.Builder workflowDetails(WorkflowDetails workflowDetails)

      Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

      In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when the server session disconnects while the file is still being uploaded.

      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 DescribedServer.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, 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.

      This is a convenience method that creates an instance of the WorkflowDetails.Builder avoiding the need to create one manually via WorkflowDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to workflowDetails(WorkflowDetails).

      Parameters:
      workflowDetails - a consumer that will call methods on WorkflowDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • structuredLogDestinations

      DescribedServer.Builder structuredLogDestinations(Collection<String> structuredLogDestinations)

      Specifies the log groups to which your server logs are sent.

      To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

      arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

      For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

      If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

      update-server --server-id s-1234567890abcdef0 --structured-log-destinations

      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

      DescribedServer.Builder structuredLogDestinations(String... structuredLogDestinations)

      Specifies the log groups to which your server logs are sent.

      To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:

      arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*

      For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*

      If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an update-server call. For example:

      update-server --server-id s-1234567890abcdef0 --structured-log-destinations

      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

      DescribedServer.Builder s3StorageOptions(S3StorageOptions s3StorageOptions)

      Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.

      By default, home directory mappings have a TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

      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 of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3StorageOptions

      default DescribedServer.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 TYPE of DIRECTORY. If you enable this option, you would then need to explicitly set the HomeDirectoryMapEntry Type to FILE if you want a mapping to have a file target.

      This is a convenience method that creates an instance of the S3StorageOptions.Builder avoiding the need to create one manually via S3StorageOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3StorageOptions(S3StorageOptions).

      Parameters:
      s3StorageOptions - a consumer that will call methods on S3StorageOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • as2ServiceManagedEgressIpAddresses

      DescribedServer.Builder as2ServiceManagedEgressIpAddresses(Collection<String> as2ServiceManagedEgressIpAddresses)

      The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

      These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

      Parameters:
      as2ServiceManagedEgressIpAddresses - The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

      These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • as2ServiceManagedEgressIpAddresses

      DescribedServer.Builder as2ServiceManagedEgressIpAddresses(String... as2ServiceManagedEgressIpAddresses)

      The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

      These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

      Parameters:
      as2ServiceManagedEgressIpAddresses - The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

      These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

      Returns:
      Returns a reference to this object so that method calls can be chained together.