Package software.amazon.awscdk.services.glue

Interface CfnConnection.ConnectionInputProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnConnection.ConnectionInputProperty.Jsii$Proxy

Enclosing class:

CfnConnection

@Stability(Stable)
public static interface CfnConnection.ConnectionInputProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object connectionProperties;
 ConnectionInputProperty connectionInputProperty = ConnectionInputProperty.builder()
         .connectionType("connectionType")
         // the properties below are optional
         .connectionProperties(connectionProperties)
         .description("description")
         .matchCriteria(List.of("matchCriteria"))
         .name("name")
         .physicalConnectionRequirements(PhysicalConnectionRequirementsProperty.builder()
                 .availabilityZone("availabilityZone")
                 .securityGroupIdList(List.of("securityGroupIdList"))
                 .subnetId("subnetId")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnConnection.ConnectionInputProperty.Builder	A builder for CfnConnection.ConnectionInputProperty
static final class	CfnConnection.ConnectionInputProperty.Jsii$Proxy	An implementation for CfnConnection.ConnectionInputProperty

Method Summary

Modifier and Type	Method	Description
static CfnConnection.ConnectionInputProperty.Builder	builder()
default Object	getConnectionProperties()	These key-value pairs define parameters for the connection.
String	getConnectionType()	The type of the connection.
default String	getDescription()	The description of the connection.
default List<String>	getMatchCriteria()	A list of criteria that can be used in selecting this connection.
default String	getName()	The name of the connection.
default Object	getPhysicalConnectionRequirements()	The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnectionType

@Stability(Stable)
@NotNull
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.
• VIEW_VALIDATION_REDSHIFT - Designates a connection used for view validation by Amazon Redshift.
• VIEW_VALIDATION_ATHENA - Designates a connection used for view validation by Amazon Athena.
• NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

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

• MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS 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 AWS Glue .

SFTP is not supported.

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectiontype

getConnectionProperties

@Stability(Stable)
@Nullable
default Object getConnectionProperties()

These key-value pairs define parameters for the connection.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectionproperties

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the connection.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-description

getMatchCriteria

@Stability(Stable)
@Nullable
default List<String> getMatchCriteria()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-matchcriteria

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the connection.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-name

getPhysicalConnectionRequirements

@Stability(Stable)
@Nullable
default Object getPhysicalConnectionRequirements()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-physicalconnectionrequirements

builder

@Stability(Stable)
static CfnConnection.ConnectionInputProperty.Builder builder()

Returns:

a CfnConnection.ConnectionInputProperty.Builder of CfnConnection.ConnectionInputProperty