Interface TestConnectionInput.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<TestConnectionInput.Builder,TestConnectionInput>,SdkBuilder<TestConnectionInput.Builder,TestConnectionInput>,SdkPojo
- Enclosing class:
- TestConnectionInput
public static interface TestConnectionInput.Builder extends SdkPojo, CopyableBuilder<TestConnectionInput.Builder,TestConnectionInput>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default TestConnectionInput.BuilderauthenticationConfiguration(Consumer<AuthenticationConfigurationInput.Builder> authenticationConfiguration)A structure containing the authentication configuration in the TestConnection request.TestConnectionInput.BuilderauthenticationConfiguration(AuthenticationConfigurationInput authenticationConfiguration)A structure containing the authentication configuration in the TestConnection request.TestConnectionInput.BuilderconnectionProperties(Map<ConnectionPropertyKey,String> connectionProperties)The key-value pairs that define parameters for the connection.TestConnectionInput.BuilderconnectionPropertiesWithStrings(Map<String,String> connectionProperties)The key-value pairs that define parameters for the connection.TestConnectionInput.BuilderconnectionType(String connectionType)The type of connection to test.TestConnectionInput.BuilderconnectionType(ConnectionType connectionType)The type of connection to test.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
connectionType
TestConnectionInput.Builder connectionType(String connectionType)
The type of connection to test. This operation is only available for the
JDBCorSALESFORCEconnection types.- Parameters:
connectionType- The type of connection to test. This operation is only available for theJDBCorSALESFORCEconnection 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
JDBCorSALESFORCEconnection types.- Parameters:
connectionType- The type of connection to test. This operation is only available for theJDBCorSALESFORCEconnection 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) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_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
AuthenticationConfigurationmember 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) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_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
AuthenticationConfigurationmember 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) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_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
AuthenticationConfigurationmember 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) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_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
AuthenticationConfigurationmember 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.
-
authenticationConfiguration
default TestConnectionInput.Builder authenticationConfiguration(Consumer<AuthenticationConfigurationInput.Builder> authenticationConfiguration)
A structure containing the authentication configuration in the TestConnection request. Required for a connection to Salesforce using OAuth authentication.
This is a convenience method that creates an instance of theAuthenticationConfigurationInput.Builderavoiding the need to create one manually viaAuthenticationConfigurationInput.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toauthenticationConfiguration(AuthenticationConfigurationInput).- Parameters:
authenticationConfiguration- a consumer that will call methods onAuthenticationConfigurationInput.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
authenticationConfiguration(AuthenticationConfigurationInput)
-
-