Package software.amazon.awssdk.services.glue.model

Interface ConnectionInput.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ConnectionInput.Builder,ConnectionInput>, SdkBuilder<ConnectionInput.Builder,ConnectionInput>, SdkPojo

Enclosing class:

ConnectionInput

public static interface ConnectionInput.Builder
extends SdkPojo, CopyableBuilder<ConnectionInput.Builder,ConnectionInput>

Method Summary

Modifier and Type	Method	Description
ConnectionInput.Builder	athenaProperties(Map<String,String> athenaProperties)	This field is not currently used.
default ConnectionInput.Builder	authenticationConfiguration(Consumer<AuthenticationConfigurationInput.Builder> authenticationConfiguration)	The authentication properties of the connection.
ConnectionInput.Builder	authenticationConfiguration(AuthenticationConfigurationInput authenticationConfiguration)	The authentication properties of the connection.
ConnectionInput.Builder	connectionProperties(Map<ConnectionPropertyKey,String> connectionProperties)	These key-value pairs define parameters for the connection.
ConnectionInput.Builder	connectionPropertiesWithStrings(Map<String,String> connectionProperties)	These key-value pairs define parameters for the connection.
ConnectionInput.Builder	connectionType(String connectionType)	The type of the connection.
ConnectionInput.Builder	connectionType(ConnectionType connectionType)	The type of the connection.
ConnectionInput.Builder	description(String description)	The description of the connection.
ConnectionInput.Builder	matchCriteria(String... matchCriteria)	A list of criteria that can be used in selecting this connection.
ConnectionInput.Builder	matchCriteria(Collection<String> matchCriteria)	A list of criteria that can be used in selecting this connection.
ConnectionInput.Builder	name(String name)	The name of the connection.
default ConnectionInput.Builder	physicalConnectionRequirements(Consumer<PhysicalConnectionRequirements.Builder> physicalConnectionRequirements)	The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
ConnectionInput.Builder	physicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)	The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
ConnectionInput.Builder	validateCredentials(Boolean validateCredentials)	A flag to validate the credentials during create connection.

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, sdkFields

Method Detail

name

ConnectionInput.Builder name(String name)

The name of the connection.

Parameters:

name - The name of the connection.

Returns:

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

description

ConnectionInput.Builder description(String description)

The description of the connection.

Parameters:

description - The description of the connection.

Returns:

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

connectionType

ConnectionInput.Builder connectionType(String connectionType)

The type of the connection. Currently, these types are supported:

• JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).

  JDBC Connections use the following ConnectionParameters.

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

• KAFKA - Designates a connection to an Apache Kafka streaming platform.

  KAFKA Connections use the following ConnectionParameters.

  • Required: KAFKA_BOOTSTRAP_SERVERS.

  • Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.

  • Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.

  • Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.

  • Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.

  • Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.

• MONGODB - Designates a connection to a MongoDB document database.

  MONGODB Connections use the following ConnectionParameters.

  • Required: CONNECTION_URL.

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

• SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

  • Requires the AuthenticationConfiguration member to be configured.

• VIEW_VALIDATION_REDSHIFT - Designates a connection used for view validation by Amazon Redshift.

• VIEW_VALIDATION_ATHENA - Designates a connection used for view validation by Amazon Athena.

• NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

  NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

• MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.

  MARKETPLACE Connections use the following ConnectionParameters.

  • Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

  • Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.

• CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.

SFTP is not supported.

For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.

For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

Parameters:

connectionType - The type of the connection. Currently, these types are supported:

• JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).

  JDBC Connections use the following ConnectionParameters.

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

• KAFKA - Designates a connection to an Apache Kafka streaming platform.

  KAFKA Connections use the following ConnectionParameters.

  • Required: KAFKA_BOOTSTRAP_SERVERS.

  • Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.

  • Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.

  • Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.

  • Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.

  • Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.

• MONGODB - Designates a connection to a MongoDB document database.

  MONGODB Connections use the following ConnectionParameters.

  • Required: CONNECTION_URL.

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

• SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

  • Requires the AuthenticationConfiguration member to be configured.

• VIEW_VALIDATION_REDSHIFT - Designates a connection used for view validation by Amazon Redshift.

• VIEW_VALIDATION_ATHENA - Designates a connection used for view validation by Amazon Athena.

• NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

  NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

• MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.

  MARKETPLACE Connections use the following ConnectionParameters.

  • Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

  • Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.

• CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.

SFTP is not supported.

For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.

For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

Returns:

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

See Also:

ConnectionType, ConnectionType

connectionType

ConnectionInput.Builder connectionType(ConnectionType connectionType)

The type of the connection. Currently, these types are supported:

• JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).

  JDBC Connections use the following ConnectionParameters.

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

• KAFKA - Designates a connection to an Apache Kafka streaming platform.

  KAFKA Connections use the following ConnectionParameters.

  • Required: KAFKA_BOOTSTRAP_SERVERS.

  • Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.

  • Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.

  • Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.

  • Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.

  • Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.

• MONGODB - Designates a connection to a MongoDB document database.

  MONGODB Connections use the following ConnectionParameters.

  • Required: CONNECTION_URL.

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

• SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

  • Requires the AuthenticationConfiguration member to be configured.

• VIEW_VALIDATION_REDSHIFT - Designates a connection used for view validation by Amazon Redshift.

• VIEW_VALIDATION_ATHENA - Designates a connection used for view validation by Amazon Athena.

• NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

  NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

• MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.

  MARKETPLACE Connections use the following ConnectionParameters.

  • Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

  • Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.

• CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.

SFTP is not supported.

For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.

For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

Parameters:

connectionType - The type of the connection. Currently, these types are supported:

• JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).

  JDBC Connections use the following ConnectionParameters.

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

• KAFKA - Designates a connection to an Apache Kafka streaming platform.

  KAFKA Connections use the following ConnectionParameters.

  • Required: KAFKA_BOOTSTRAP_SERVERS.

  • Optional: KAFKA_SSL_ENABLED, KAFKA_CUSTOM_CERT, KAFKA_SKIP_CUSTOM_CERT_VALIDATION. These parameters are used to configure SSL with KAFKA.

  • Optional: KAFKA_CLIENT_KEYSTORE, KAFKA_CLIENT_KEYSTORE_PASSWORD, KAFKA_CLIENT_KEY_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD, ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD. These parameters are used to configure TLS client configuration with SSL in KAFKA.

  • Optional: KAFKA_SASL_MECHANISM. Can be specified as SCRAM-SHA-512, GSSAPI, or AWS_MSK_IAM.

  • Optional: KAFKA_SASL_SCRAM_USERNAME, KAFKA_SASL_SCRAM_PASSWORD, ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD. These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA.

  • Optional: KAFKA_SASL_GSSAPI_KEYTAB, KAFKA_SASL_GSSAPI_KRB5_CONF, KAFKA_SASL_GSSAPI_SERVICE, KAFKA_SASL_GSSAPI_PRINCIPAL. These parameters are used to configure SASL/GSSAPI authentication with KAFKA.

• MONGODB - Designates a connection to a MongoDB document database.

  MONGODB Connections use the following ConnectionParameters.

  • Required: CONNECTION_URL.

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

• SALESFORCE - Designates a connection to Salesforce using OAuth authencation.

  • Requires the AuthenticationConfiguration member to be configured.

• VIEW_VALIDATION_REDSHIFT - Designates a connection used for view validation by Amazon Redshift.

• VIEW_VALIDATION_ATHENA - Designates a connection used for view validation by Amazon Athena.

• NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

  NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

• MARKETPLACE - Uses configuration settings contained in a connector purchased from Amazon Web Services Marketplace to read from and write to data stores that are not natively supported by Glue.

  MARKETPLACE Connections use the following ConnectionParameters.

  • Required: CONNECTOR_TYPE, CONNECTOR_URL, CONNECTOR_CLASS_NAME, CONNECTION_URL.

  • Required for JDBC CONNECTOR_TYPE connections: All of (USERNAME, PASSWORD) or SECRET_ID.

• CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by Glue.

SFTP is not supported.

For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.

For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.

Returns:

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

See Also:

ConnectionType, ConnectionType

matchCriteria

ConnectionInput.Builder matchCriteria(Collection<String> matchCriteria)

A list of criteria that can be used in selecting this connection.

Parameters:

matchCriteria - A list of criteria that can be used in selecting this connection.

Returns:

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

matchCriteria

ConnectionInput.Builder matchCriteria(String... matchCriteria)

A list of criteria that can be used in selecting this connection.

Parameters:

matchCriteria - A list of criteria that can be used in selecting this connection.

Returns:

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

connectionPropertiesWithStrings

ConnectionInput.Builder connectionPropertiesWithStrings(Map<String,String> connectionProperties)

These key-value pairs define parameters for the connection.

Parameters:

connectionProperties - These key-value pairs define parameters for the connection.

Returns:

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

connectionProperties

ConnectionInput.Builder connectionProperties(Map<ConnectionPropertyKey,String> connectionProperties)

These key-value pairs define parameters for the connection.

Parameters:

connectionProperties - These key-value pairs define parameters for the connection.

Returns:

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

athenaProperties

ConnectionInput.Builder athenaProperties(Map<String,String> athenaProperties)

This field is not currently used.

Parameters:

athenaProperties - This field is not currently used.

Returns:

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

physicalConnectionRequirements

ConnectionInput.Builder physicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)

The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

Parameters:

physicalConnectionRequirements - The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

Returns:

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

physicalConnectionRequirements

default ConnectionInput.Builder physicalConnectionRequirements(Consumer<PhysicalConnectionRequirements.Builder> physicalConnectionRequirements)

The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

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

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

Parameters:

physicalConnectionRequirements - a consumer that will call methods on PhysicalConnectionRequirements.Builder

Returns:

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

See Also:

physicalConnectionRequirements(PhysicalConnectionRequirements)

authenticationConfiguration

ConnectionInput.Builder authenticationConfiguration(AuthenticationConfigurationInput authenticationConfiguration)

The authentication properties of the connection. Used for a Salesforce connection.

Parameters:

authenticationConfiguration - The authentication properties of the connection. Used for a Salesforce connection.

Returns:

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

authenticationConfiguration

default ConnectionInput.Builder authenticationConfiguration(Consumer<AuthenticationConfigurationInput.Builder> authenticationConfiguration)

The authentication properties of the connection. Used for a Salesforce connection.

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

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

Parameters:

authenticationConfiguration - a consumer that will call methods on AuthenticationConfigurationInput.Builder

Returns:

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

See Also:

authenticationConfiguration(AuthenticationConfigurationInput)

validateCredentials

ConnectionInput.Builder validateCredentials(Boolean validateCredentials)

A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.

Parameters:

validateCredentials - A flag to validate the credentials during create connection. Used for a Salesforce connection. Default is true.

Returns:

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