@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.
Constructor and Description |
---|
ConnectionInput() |
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) |
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()
A map of physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup ,
that are needed to successfully make this connection. |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
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)
A map of physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup ,
that are needed to successfully make this connection. |
String |
toString()
Returns a string representation of this object.
|
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)
A map of physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup ,
that are needed to successfully make this connection. |
public void setName(String name)
The name of the connection. Connection will not function as expected without a name.
name
- The name of the connection. Connection will not function as expected without a name.public String getName()
The name of the connection. Connection will not function as expected without a name.
public ConnectionInput withName(String name)
The name of the connection. Connection will not function as expected without a name.
name
- The name of the connection. Connection will not function as expected without a name.public void setDescription(String description)
The description of the connection.
description
- The description of the connection.public String getDescription()
The description of the connection.
public ConnectionInput withDescription(String description)
The description of the connection.
description
- The description of the connection.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
.
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.
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
.
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.
ConnectionType
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
.
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.
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
.
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.
ConnectionType
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
.
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.
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
.
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.
ConnectionType
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
.
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.
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
.
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.
ConnectionType
public List<String> getMatchCriteria()
A list of criteria that can be used in selecting this connection.
public void setMatchCriteria(Collection<String> matchCriteria)
A list of criteria that can be used in selecting this connection.
matchCriteria
- A list of criteria that can be used in selecting this connection.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.
matchCriteria
- A list of criteria that can be used in selecting this connection.public ConnectionInput withMatchCriteria(Collection<String> matchCriteria)
A list of criteria that can be used in selecting this connection.
matchCriteria
- A list of criteria that can be used in selecting this connection.public Map<String,String> getConnectionProperties()
These key-value pairs define parameters for the connection.
public void setConnectionProperties(Map<String,String> connectionProperties)
These key-value pairs define parameters for the connection.
connectionProperties
- These key-value pairs define parameters for the connection.public ConnectionInput withConnectionProperties(Map<String,String> connectionProperties)
These key-value pairs define parameters for the connection.
connectionProperties
- These key-value pairs define parameters for the connection.public ConnectionInput addConnectionPropertiesEntry(String key, String value)
public ConnectionInput clearConnectionPropertiesEntries()
public void setPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
,
that are needed to successfully make this connection.
physicalConnectionRequirements
- A map of physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup
, that are needed to successfully make this connection.public PhysicalConnectionRequirements getPhysicalConnectionRequirements()
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
,
that are needed to successfully make this connection.
SecurityGroup
, that are needed to successfully make this connection.public ConnectionInput withPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)
A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
,
that are needed to successfully make this connection.
physicalConnectionRequirements
- A map of physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup
, that are needed to successfully make this connection.public String toString()
toString
in class Object
Object.toString()
public ConnectionInput clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.