AWS::Glue::Connection ConnectionInput

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON


{
  "AthenaProperties" : Json,
  "AuthenticationConfiguration" : AuthenticationConfigurationInput,
  "ConnectionProperties" : Json,
  "ConnectionType" : String,
  "Description" : String,
  "MatchCriteria" : [ String, ... ],
  "Name" : String,
  "PhysicalConnectionRequirements" : PhysicalConnectionRequirements,
  "PythonProperties" : Json,
  "SparkProperties" : Json,
  "ValidateCredentials" : Boolean,
  "ValidateForComputeEnvironments" : [ String, ... ]
}

YAML


  AthenaProperties: Json
  AuthenticationConfiguration: 
    AuthenticationConfigurationInput
  ConnectionProperties: Json
  ConnectionType: String
  Description: String
  MatchCriteria: 
    - String
  Name: String
  PhysicalConnectionRequirements: 
    PhysicalConnectionRequirements
  PythonProperties: Json
  SparkProperties: Json
  ValidateCredentials: Boolean
  ValidateForComputeEnvironments: 
    - String

Properties

AthenaProperties

Connection properties specific to the Athena compute environment.

Required: No

Type: Json

Update requires: No interruption

AuthenticationConfiguration

The authentication properties of the connection.

Required: No

Type: AuthenticationConfigurationInput

Update requires: No interruption

ConnectionProperties

These key-value pairs define parameters for the connection.

Required: No

Type: Json

Update requires: No interruption

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

Additionally, a ConnectionType for the following SaaS connectors is supported:

FACEBOOKADS - Designates a connection to Facebook Ads.
GOOGLEADS - Designates a connection to Google Ads.
GOOGLESHEETS - Designates a connection to Google Sheets.
GOOGLEANALYTICS4 - Designates a connection to Google Analytics 4.
HUBSPOT - Designates a connection to HubSpot.
INSTAGRAMADS - Designates a connection to Instagram Ads.
INTERCOM - Designates a connection to Intercom.
JIRACLOUD - Designates a connection to Jira Cloud.
MARKETO - Designates a connection to Adobe Marketo Engage.
NETSUITEERP - Designates a connection to Oracle NetSuite.
SALESFORCE - Designates a connection to Salesforce using OAuth authentication.
SALESFORCEMARKETINGCLOUD - Designates a connection to Salesforce Marketing Cloud.
SALESFORCEPARDOT - Designates a connection to Salesforce Marketing Cloud Account Engagement (MCAE).
SAPODATA - Designates a connection to SAP OData.
SERVICENOW - Designates a connection to ServiceNow.
SLACK - Designates a connection to Slack.
SNAPCHATADS - Designates a connection to Snapchat Ads.
STRIPE - Designates a connection to Stripe.
ZENDESK - Designates a connection to Zendesk.
ZOHOCRM - Designates a connection to Zoho CRM.

For more information on the connection parameters needed for a particular connector, see the documentation for the connector in Adding an AWS Glue connectionin the AWS Glue User Guide.

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.

Required: Yes

Type: String

Update requires: No interruption

Description

The description of the connection.

Required: No

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Minimum: 0

Maximum: 2048

Update requires: No interruption

MatchCriteria

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

Required: No

Type: Array of String

Minimum: 0

Maximum: 10

Update requires: No interruption

Name

The name of the connection.

Required: No

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Minimum: 1

Maximum: 255

Update requires: No interruption

PhysicalConnectionRequirements

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

Required: No

Type: PhysicalConnectionRequirements

Update requires: No interruption

PythonProperties

Connection properties specific to the Python compute environment.

Required: No

Type: Json

Update requires: No interruption

SparkProperties

Connection properties specific to the Spark compute environment.

Required: No

Type: Json

Update requires: No interruption

ValidateCredentials

A flag to validate the credentials during create connection. Default is true.

Required: No

Type: Boolean

Update requires: No interruption

ValidateForComputeEnvironments

The compute environments that the specified connection properties are validated against.

Required: No

Type: Array of String

Update requires: No interruption

Warning Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Document Conventions

BasicAuthenticationCredentials

OAuth2ClientApplication