Interface TestConnectionInput.Builder

    • Method Detail

      • connectionType

        TestConnectionInput.Builder connectionType​(String connectionType)

        The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.

        Parameters:
        connectionType - The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ConnectionType, ConnectionType
      • connectionType

        TestConnectionInput.Builder connectionType​(ConnectionType connectionType)

        The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.

        Parameters:
        connectionType - The type of connection to test. This operation is only available for the JDBC or SALESFORCE connection types.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ConnectionType, ConnectionType
      • connectionPropertiesWithStrings

        TestConnectionInput.Builder connectionPropertiesWithStrings​(Map<String,​String> connectionProperties)

        The key-value pairs that define parameters for the connection.

        JDBC connections use the following connection properties:

        • Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

        • Required: All of (USERNAME, PASSWORD) or SECRET_ID.

        • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

        SALESFORCE connections require the AuthenticationConfiguration member to be configured.

        Parameters:
        connectionProperties - The key-value pairs that define parameters for the connection.

        JDBC connections use the following connection properties:

        • Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

        • Required: All of (USERNAME, PASSWORD) or SECRET_ID.

        • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

        SALESFORCE connections require the AuthenticationConfiguration member to be configured.

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

        TestConnectionInput.Builder connectionProperties​(Map<ConnectionPropertyKey,​String> connectionProperties)

        The key-value pairs that define parameters for the connection.

        JDBC connections use the following connection properties:

        • Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

        • Required: All of (USERNAME, PASSWORD) or SECRET_ID.

        • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

        SALESFORCE connections require the AuthenticationConfiguration member to be configured.

        Parameters:
        connectionProperties - The key-value pairs that define parameters for the connection.

        JDBC connections use the following connection properties:

        • Required: All of (HOST, PORT, JDBC_ENGINE) or JDBC_CONNECTION_URL.

        • Required: All of (USERNAME, PASSWORD) or SECRET_ID.

        • Optional: JDBC_ENFORCE_SSL, CUSTOM_JDBC_CERT, CUSTOM_JDBC_CERT_STRING, SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.

        SALESFORCE connections require the AuthenticationConfiguration member to be configured.

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

        TestConnectionInput.Builder authenticationConfiguration​(AuthenticationConfigurationInput authenticationConfiguration)

        A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.

        Parameters:
        authenticationConfiguration - A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.
        Returns:
        Returns a reference to this object so that method calls can be chained together.