Interface ConnectionInput.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ConnectionInput.Builder,ConnectionInput>,SdkBuilder<ConnectionInput.Builder,ConnectionInput>,SdkPojo
- Enclosing class:
- ConnectionInput
public static interface ConnectionInput.Builder extends SdkPojo, CopyableBuilder<ConnectionInput.Builder,ConnectionInput>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description ConnectionInput.BuilderconnectionProperties(Map<ConnectionPropertyKey,String> connectionProperties)These key-value pairs define parameters for the connection.ConnectionInput.BuilderconnectionPropertiesWithStrings(Map<String,String> connectionProperties)These key-value pairs define parameters for the connection.ConnectionInput.BuilderconnectionType(String connectionType)The type of the connection.ConnectionInput.BuilderconnectionType(ConnectionType connectionType)The type of the connection.ConnectionInput.Builderdescription(String description)The description of the connection.ConnectionInput.BuildermatchCriteria(String... matchCriteria)A list of criteria that can be used in selecting this connection.ConnectionInput.BuildermatchCriteria(Collection<String> matchCriteria)A list of criteria that can be used in selecting this connection.ConnectionInput.Buildername(String name)The name of the connection.default ConnectionInput.BuilderphysicalConnectionRequirements(Consumer<PhysicalConnectionRequirements.Builder> physicalConnectionRequirements)A map of physical connection requirements, such as virtual private cloud (VPC) andSecurityGroup, that are needed to successfully make this connection.ConnectionInput.BuilderphysicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)A map of physical connection requirements, such as virtual private cloud (VPC) andSecurityGroup, that are needed to successfully make this connection.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
name
ConnectionInput.Builder name(String name)
The name of the connection. Connection will not function as expected without a name.
- Parameters:
name- The name of the connection. Connection will not function as expected without a name.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
ConnectionInput.Builder description(String description)
The description of the connection.
- Parameters:
description- The description of the connection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
connectionType
ConnectionInput.Builder connectionType(String connectionType)
The type of the connection. Currently, these types are supported:
-
JDBC- Designates a connection to a database through Java Database Connectivity (JDBC).JDBCConnections use the following ConnectionParameters.-
Required: All of (
HOST,PORT,JDBC_ENGINE) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_ID. -
Optional:
JDBC_ENFORCE_SSL,CUSTOM_JDBC_CERT,CUSTOM_JDBC_CERT_STRING,SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
-
-
KAFKA- Designates a connection to an Apache Kafka streaming platform.KAFKAConnections 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 withKAFKA. -
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 inKAFKA. -
Optional:
KAFKA_SASL_MECHANISM. Can be specified asSCRAM-SHA-512,GSSAPI, orAWS_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 withKAFKA. -
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 withKAFKA.
-
-
MONGODB- Designates a connection to a MongoDB document database.MONGODBConnections use the following ConnectionParameters.-
Required:
CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_ID.
-
-
NETWORK- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORKConnections 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.MARKETPLACEConnections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE,CONNECTOR_URL,CONNECTOR_CLASS_NAME,CONNECTION_URL. -
Required for
JDBCCONNECTOR_TYPEconnections: All of (USERNAME,PASSWORD) orSECRET_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.
SFTPis 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).JDBCConnections use the following ConnectionParameters.-
Required: All of (
HOST,PORT,JDBC_ENGINE) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_ID. -
Optional:
JDBC_ENFORCE_SSL,CUSTOM_JDBC_CERT,CUSTOM_JDBC_CERT_STRING,SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
-
-
KAFKA- Designates a connection to an Apache Kafka streaming platform.KAFKAConnections 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 withKAFKA. -
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 inKAFKA. -
Optional:
KAFKA_SASL_MECHANISM. Can be specified asSCRAM-SHA-512,GSSAPI, orAWS_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 withKAFKA. -
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 withKAFKA.
-
-
MONGODB- Designates a connection to a MongoDB document database.MONGODBConnections use the following ConnectionParameters.-
Required:
CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_ID.
-
-
NETWORK- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORKConnections 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.MARKETPLACEConnections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE,CONNECTOR_URL,CONNECTOR_CLASS_NAME,CONNECTION_URL. -
Required for
JDBCCONNECTOR_TYPEconnections: All of (USERNAME,PASSWORD) orSECRET_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.
SFTPis not supported.For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ConnectionType,ConnectionType
-
-
connectionType
ConnectionInput.Builder connectionType(ConnectionType connectionType)
The type of the connection. Currently, these types are supported:
-
JDBC- Designates a connection to a database through Java Database Connectivity (JDBC).JDBCConnections use the following ConnectionParameters.-
Required: All of (
HOST,PORT,JDBC_ENGINE) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_ID. -
Optional:
JDBC_ENFORCE_SSL,CUSTOM_JDBC_CERT,CUSTOM_JDBC_CERT_STRING,SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
-
-
KAFKA- Designates a connection to an Apache Kafka streaming platform.KAFKAConnections 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 withKAFKA. -
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 inKAFKA. -
Optional:
KAFKA_SASL_MECHANISM. Can be specified asSCRAM-SHA-512,GSSAPI, orAWS_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 withKAFKA. -
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 withKAFKA.
-
-
MONGODB- Designates a connection to a MongoDB document database.MONGODBConnections use the following ConnectionParameters.-
Required:
CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_ID.
-
-
NETWORK- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORKConnections 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.MARKETPLACEConnections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE,CONNECTOR_URL,CONNECTOR_CLASS_NAME,CONNECTION_URL. -
Required for
JDBCCONNECTOR_TYPEconnections: All of (USERNAME,PASSWORD) orSECRET_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.
SFTPis 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).JDBCConnections use the following ConnectionParameters.-
Required: All of (
HOST,PORT,JDBC_ENGINE) orJDBC_CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_ID. -
Optional:
JDBC_ENFORCE_SSL,CUSTOM_JDBC_CERT,CUSTOM_JDBC_CERT_STRING,SKIP_CUSTOM_JDBC_CERT_VALIDATION. These parameters are used to configure SSL with JDBC.
-
-
KAFKA- Designates a connection to an Apache Kafka streaming platform.KAFKAConnections 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 withKAFKA. -
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 inKAFKA. -
Optional:
KAFKA_SASL_MECHANISM. Can be specified asSCRAM-SHA-512,GSSAPI, orAWS_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 withKAFKA. -
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 withKAFKA.
-
-
MONGODB- Designates a connection to a MongoDB document database.MONGODBConnections use the following ConnectionParameters.-
Required:
CONNECTION_URL. -
Required: All of (
USERNAME,PASSWORD) orSECRET_ID.
-
-
NETWORK- Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).NETWORKConnections 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.MARKETPLACEConnections use the following ConnectionParameters.-
Required:
CONNECTOR_TYPE,CONNECTOR_URL,CONNECTOR_CLASS_NAME,CONNECTION_URL. -
Required for
JDBCCONNECTOR_TYPEconnections: All of (USERNAME,PASSWORD) orSECRET_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.
SFTPis not supported.For more information about how optional ConnectionProperties are used to configure features in Glue, consult Glue connection properties.
For more information about how optional ConnectionProperties are used to configure features in Glue Studio, consult Using connectors and connections.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ConnectionType,ConnectionType
-
-
matchCriteria
ConnectionInput.Builder matchCriteria(Collection<String> matchCriteria)
A list of criteria that can be used in selecting this connection.
- Parameters:
matchCriteria- A list of criteria that can be used in selecting this connection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
matchCriteria
ConnectionInput.Builder matchCriteria(String... matchCriteria)
A list of criteria that can be used in selecting this connection.
- Parameters:
matchCriteria- A list of criteria that can be used in selecting this connection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
connectionPropertiesWithStrings
ConnectionInput.Builder connectionPropertiesWithStrings(Map<String,String> connectionProperties)
These key-value pairs define parameters for the connection.
- Parameters:
connectionProperties- These key-value pairs define parameters for the connection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
connectionProperties
ConnectionInput.Builder connectionProperties(Map<ConnectionPropertyKey,String> connectionProperties)
These key-value pairs define parameters for the connection.
- Parameters:
connectionProperties- These key-value pairs define parameters for the connection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
physicalConnectionRequirements
ConnectionInput.Builder physicalConnectionRequirements(PhysicalConnectionRequirements physicalConnectionRequirements)
A map of physical connection requirements, such as virtual private cloud (VPC) and
SecurityGroup, that are needed to successfully make this connection.- Parameters:
physicalConnectionRequirements- A map of physical connection requirements, such as virtual private cloud (VPC) andSecurityGroup, that are needed to successfully make this connection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
physicalConnectionRequirements
default ConnectionInput.Builder physicalConnectionRequirements(Consumer<PhysicalConnectionRequirements.Builder> physicalConnectionRequirements)
A map of physical connection requirements, such as virtual private cloud (VPC) and
This is a convenience method that creates an instance of theSecurityGroup, that are needed to successfully make this connection.PhysicalConnectionRequirements.Builderavoiding the need to create one manually viaPhysicalConnectionRequirements.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tophysicalConnectionRequirements(PhysicalConnectionRequirements).- Parameters:
physicalConnectionRequirements- a consumer that will call methods onPhysicalConnectionRequirements.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
physicalConnectionRequirements(PhysicalConnectionRequirements)
-
-