com.amazonaws.services.glue.model

Class ConnectionInput

java.lang.Object

com.amazonaws.services.glue.model.ConnectionInput

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ConnectionInput
extends Object
implements Serializable, Cloneable, StructuredPojo

A structure that is used to specify a connection to create or update.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConnectionInput()

Method Summary

Modifier and Type	Method and Description
ConnectionInput	addConnectionPropertiesEntry(String key, String value) Add a single ConnectionProperties entry
ConnectionInput	clearConnectionPropertiesEntries() Removes all the entries added into ConnectionProperties.
ConnectionInput	clone()
boolean	equals(Object obj)
AuthenticationConfigurationInput	getAuthenticationConfiguration() The authentication properties of the connection.
Map<String,String>	getConnectionProperties() These key-value pairs define parameters for the connection.
String	getConnectionType() The type of the connection.
String	getDescription() The description of the connection.
List<String>	getMatchCriteria() A list of criteria that can be used in selecting this connection.
String	getName() The name of the connection.
PhysicalConnectionRequirements	getPhysicalConnectionRequirements() The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
Boolean	getValidateCredentials() A flag to validate the credentials during create connection.
int	hashCode()
Boolean	isValidateCredentials() A flag to validate the credentials during create connection.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAuthenticationConfiguration(AuthenticationConfigurationInput authenticationConfiguration) The authentication properties of the connection.
void	setConnectionProperties(Map<String,String> connectionProperties) These key-value pairs define parameters for the connection.
void	setConnectionType(String connectionType) The type of the connection.
void	setDescription(String description) The description of the connection.
void	setMatchCriteria(Collection<String> matchCriteria) A list of criteria that can be used in selecting this connection.
void	setName(String name) The name of the connection.
void	setPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements) The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
void	setValidateCredentials(Boolean validateCredentials) A flag to validate the credentials during create connection.
String	toString() Returns a string representation of this object.
ConnectionInput	withAuthenticationConfiguration(AuthenticationConfigurationInput authenticationConfiguration) The authentication properties of the connection.
ConnectionInput	withConnectionProperties(Map<String,String> connectionProperties) These key-value pairs define parameters for the connection.
ConnectionInput	withConnectionType(ConnectionType connectionType) The type of the connection.
ConnectionInput	withConnectionType(String connectionType) The type of the connection.
ConnectionInput	withDescription(String description) The description of the connection.
ConnectionInput	withMatchCriteria(Collection<String> matchCriteria) A list of criteria that can be used in selecting this connection.
ConnectionInput	withMatchCriteria(String... matchCriteria) A list of criteria that can be used in selecting this connection.
ConnectionInput	withName(String name) The name of the connection.
ConnectionInput	withPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements) The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.
ConnectionInput	withValidateCredentials(Boolean validateCredentials) A flag to validate the credentials during create connection.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConnectionInput

public ConnectionInput()

Method Detail

setName

public void setName(String name)

The name of the connection.

Parameters:

name - The name of the connection.

getName

public String getName()

The name of the connection.

Returns:

The name of the connection.

withName

public ConnectionInput withName(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.

setDescription

public void setDescription(String description)

The description of the connection.

Parameters:

description - The description of the connection.

getDescription

public String getDescription()

The description of the connection.

Returns:

The description of the connection.

withDescription

public ConnectionInput withDescription(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.

setConnectionType

public void setConnectionType(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.

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

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

See Also:

ConnectionType

getConnectionType

public String getConnectionType()

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.

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

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.

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

See Also:

ConnectionType

withConnectionType

public ConnectionInput withConnectionType(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.

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

• 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

withConnectionType

public ConnectionInput withConnectionType(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.

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

• 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

getMatchCriteria

public List<String> getMatchCriteria()

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

Returns:

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

setMatchCriteria

public void setMatchCriteria(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.

withMatchCriteria

public ConnectionInput withMatchCriteria(String... matchCriteria)

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

NOTE: This method appends the values to the existing list (if any). Use setMatchCriteria(java.util.Collection) or withMatchCriteria(java.util.Collection) if you want to override the existing values.

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.

withMatchCriteria

public ConnectionInput withMatchCriteria(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.

getConnectionProperties

public Map<String,String> getConnectionProperties()

These key-value pairs define parameters for the connection.

Returns:

These key-value pairs define parameters for the connection.

setConnectionProperties

public void setConnectionProperties(Map<String,String> connectionProperties)

These key-value pairs define parameters for the connection.

Parameters:

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

withConnectionProperties

public ConnectionInput withConnectionProperties(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.

addConnectionPropertiesEntry

public ConnectionInput addConnectionPropertiesEntry(String key,
                                                    String value)

Add a single ConnectionProperties entry

See Also:

withConnectionProperties(java.util.Map<java.lang.String, java.lang.String>)

clearConnectionPropertiesEntries

public ConnectionInput clearConnectionPropertiesEntries()

Removes all the entries added into ConnectionProperties.

Returns:

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

setPhysicalConnectionRequirements

public void setPhysicalConnectionRequirements(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.

getPhysicalConnectionRequirements

public PhysicalConnectionRequirements getPhysicalConnectionRequirements()

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

Returns:

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

withPhysicalConnectionRequirements

public ConnectionInput withPhysicalConnectionRequirements(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.

setAuthenticationConfiguration

public void setAuthenticationConfiguration(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.

getAuthenticationConfiguration

public AuthenticationConfigurationInput getAuthenticationConfiguration()

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

Returns:

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

withAuthenticationConfiguration

public ConnectionInput withAuthenticationConfiguration(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.

setValidateCredentials

public void setValidateCredentials(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.

getValidateCredentials

public Boolean getValidateCredentials()

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

Returns:

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

withValidateCredentials

public ConnectionInput withValidateCredentials(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.

isValidateCredentials

public Boolean isValidateCredentials()

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

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ConnectionInput clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.