/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.glue.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* A structure that is used to specify a connection to create or update. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ConnectionInput implements Serializable, Cloneable, StructuredPojo { /** ** The name of the connection. Connection will not function as expected without a name. *
*/ private String name; /** ** The description of the connection. *
*/ private String description; /** ** 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. *
*/ private String connectionType; /** ** A list of criteria that can be used in selecting this connection. *
*/ private java.util.List* These key-value pairs define parameters for the connection. *
*/ private java.util.Map
* A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
,
* that are needed to successfully make this connection.
*
* The name of the connection. Connection will not function as expected without a name. *
* * @param name * The name of the connection. Connection will not function as expected without a name. */ public void setName(String name) { this.name = name; } /** ** The name of the connection. Connection will not function as expected without a name. *
* * @return The name of the connection. Connection will not function as expected without a name. */ public String getName() { return this.name; } /** ** The name of the connection. Connection will not function as expected without a name. *
* * @param name * The name of the connection. Connection will not function as expected without a name. * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionInput withName(String name) { setName(name); return this; } /** ** The description of the connection. *
* * @param description * The description of the connection. */ public void setDescription(String description) { this.description = description; } /** ** The description of the connection. *
* * @return The description of the connection. */ public String getDescription() { return this.description; } /** ** The description of the connection. *
* * @param description * The description of the connection. * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionInput withDescription(String description) { setDescription(description); return this; } /** ** 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. *
* * @param 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. * @see ConnectionType */ public void setConnectionType(String connectionType) { this.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. *
* * @return 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. * @see ConnectionType */ public String getConnectionType() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see ConnectionType */ public ConnectionInput withConnectionType(String connectionType) { setConnectionType(connectionType); return this; } /** *
* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. * @see ConnectionType */ public ConnectionInput withConnectionType(ConnectionType connectionType) { this.connectionType = connectionType.toString(); return this; } /** *
* A list of criteria that can be used in selecting this connection. *
* * @return A list of criteria that can be used in selecting this connection. */ public java.util.List* A list of criteria that can be used in selecting this connection. *
* * @param matchCriteria * A list of criteria that can be used in selecting this connection. */ public void setMatchCriteria(java.util.Collection* 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 * {@link #setMatchCriteria(java.util.Collection)} or {@link #withMatchCriteria(java.util.Collection)} if you want * to override the existing values. *
* * @param matchCriteria * A list of criteria that can be used in selecting this connection. * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionInput withMatchCriteria(String... matchCriteria) { if (this.matchCriteria == null) { setMatchCriteria(new java.util.ArrayList* A list of criteria that can be used in selecting this connection. *
* * @param matchCriteria * A list of criteria that can be used in selecting this connection. * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionInput withMatchCriteria(java.util.Collection* These key-value pairs define parameters for the connection. *
* * @return These key-value pairs define parameters for the connection. */ public java.util.Map* These key-value pairs define parameters for the connection. *
* * @param connectionProperties * These key-value pairs define parameters for the connection. */ public void setConnectionProperties(java.util.Map* These key-value pairs define parameters for the connection. *
* * @param connectionProperties * These key-value pairs define parameters for the connection. * @return Returns a reference to this object so that method calls can be chained together. */ public ConnectionInput withConnectionProperties(java.util.Map
* 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 void setPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements) {
this.physicalConnectionRequirements = physicalConnectionRequirements;
}
/**
*
* 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 PhysicalConnectionRequirements getPhysicalConnectionRequirements() {
return this.physicalConnectionRequirements;
}
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ConnectionInput withPhysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements) {
setPhysicalConnectionRequirements(physicalConnectionRequirements);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getConnectionType() != null)
sb.append("ConnectionType: ").append(getConnectionType()).append(",");
if (getMatchCriteria() != null)
sb.append("MatchCriteria: ").append(getMatchCriteria()).append(",");
if (getConnectionProperties() != null)
sb.append("ConnectionProperties: ").append(getConnectionProperties()).append(",");
if (getPhysicalConnectionRequirements() != null)
sb.append("PhysicalConnectionRequirements: ").append(getPhysicalConnectionRequirements());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ConnectionInput == false)
return false;
ConnectionInput other = (ConnectionInput) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getConnectionType() == null ^ this.getConnectionType() == null)
return false;
if (other.getConnectionType() != null && other.getConnectionType().equals(this.getConnectionType()) == false)
return false;
if (other.getMatchCriteria() == null ^ this.getMatchCriteria() == null)
return false;
if (other.getMatchCriteria() != null && other.getMatchCriteria().equals(this.getMatchCriteria()) == false)
return false;
if (other.getConnectionProperties() == null ^ this.getConnectionProperties() == null)
return false;
if (other.getConnectionProperties() != null && other.getConnectionProperties().equals(this.getConnectionProperties()) == false)
return false;
if (other.getPhysicalConnectionRequirements() == null ^ this.getPhysicalConnectionRequirements() == null)
return false;
if (other.getPhysicalConnectionRequirements() != null
&& other.getPhysicalConnectionRequirements().equals(this.getPhysicalConnectionRequirements()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getConnectionType() == null) ? 0 : getConnectionType().hashCode());
hashCode = prime * hashCode + ((getMatchCriteria() == null) ? 0 : getMatchCriteria().hashCode());
hashCode = prime * hashCode + ((getConnectionProperties() == null) ? 0 : getConnectionProperties().hashCode());
hashCode = prime * hashCode + ((getPhysicalConnectionRequirements() == null) ? 0 : getPhysicalConnectionRequirements().hashCode());
return hashCode;
}
@Override
public ConnectionInput clone() {
try {
return (ConnectionInput) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.glue.model.transform.ConnectionInputMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}