Skip to content

TestConnectionInput

Used by
Source code in docs_src/capo_glue/types/test_connection_input.py 
15
16
17
18
19
20
21
22
23
class TestConnectionInput(TypedDict, closed=True):
    connection_type: "capo_glue.types.connection_type.ConnectionType"
    """<p>The type of connection to test. This operation is only available for the <code>JDBC</code> or <code>SALESFORCE</code> connection types.</p>"""
    connection_properties: "capo_glue.types.connection_properties.ConnectionProperties"
    """<p>The key-value pairs that define parameters for the connection.</p> <p>JDBC connections use the following connection properties:</p> <ul> <li> <p>Required: All of (<code>HOST</code>, <code>PORT</code>, <code>JDBC_ENGINE</code>) or <code>JDBC_CONNECTION_URL</code>.</p> </li> <li> <p>Required: All of (<code>USERNAME</code>, <code>PASSWORD</code>) or <code>SECRET_ID</code>.</p> </li> <li> <p>Optional: <code>JDBC_ENFORCE_SSL</code>, <code>CUSTOM_JDBC_CERT</code>, <code>CUSTOM_JDBC_CERT_STRING</code>, <code>SKIP_CUSTOM_JDBC_CERT_VALIDATION</code>. These parameters are used to configure SSL with JDBC.</p> </li> </ul> <p>SALESFORCE connections require the <code>AuthenticationConfiguration</code> member to be configured.</p>"""
    authentication_configuration: NotRequired[
        "capo_glue.types.authentication_configuration_input.AuthenticationConfigurationInput"
    ]
    """<p>A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.</p>"""

authentication_configuration instance-attribute 

authentication_configuration: NotRequired[AuthenticationConfigurationInput]

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

connection_properties instance-attribute 

connection_properties: 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.

connection_type instance-attribute 

connection_type: ConnectionType

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