interface ConnectionInputProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Glue.CfnConnection.ConnectionInputProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnConnection_ConnectionInputProperty |
![]() | software.amazon.awscdk.services.glue.CfnConnection.ConnectionInputProperty |
![]() | aws_cdk.aws_glue.CfnConnection.ConnectionInputProperty |
![]() | aws-cdk-lib » aws_glue » CfnConnection » ConnectionInputProperty |
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 { aws_glue as glue } from 'aws-cdk-lib';
declare const athenaProperties: any;
declare const connectionProperties: any;
declare const customAuthenticationCredentials: any;
declare const pythonProperties: any;
declare const sparkProperties: any;
declare const tokenUrlParametersMap: any;
const connectionInputProperty: glue.CfnConnection.ConnectionInputProperty = {
connectionType: 'connectionType',
// the properties below are optional
athenaProperties: athenaProperties,
authenticationConfiguration: {
authenticationType: 'authenticationType',
// the properties below are optional
basicAuthenticationCredentials: {
password: 'password',
username: 'username',
},
customAuthenticationCredentials: customAuthenticationCredentials,
kmsKeyArn: 'kmsKeyArn',
oAuth2Properties: {
authorizationCodeProperties: {
authorizationCode: 'authorizationCode',
redirectUri: 'redirectUri',
},
oAuth2ClientApplication: {
awsManagedClientApplicationReference: 'awsManagedClientApplicationReference',
userManagedClientApplicationClientId: 'userManagedClientApplicationClientId',
},
oAuth2Credentials: {
accessToken: 'accessToken',
jwtToken: 'jwtToken',
refreshToken: 'refreshToken',
userManagedClientApplicationClientSecret: 'userManagedClientApplicationClientSecret',
},
oAuth2GrantType: 'oAuth2GrantType',
tokenUrl: 'tokenUrl',
tokenUrlParametersMap: tokenUrlParametersMap,
},
secretArn: 'secretArn',
},
connectionProperties: connectionProperties,
description: 'description',
matchCriteria: ['matchCriteria'],
name: 'name',
physicalConnectionRequirements: {
availabilityZone: 'availabilityZone',
securityGroupIdList: ['securityGroupIdList'],
subnetId: 'subnetId',
},
pythonProperties: pythonProperties,
sparkProperties: sparkProperties,
validateCredentials: false,
validateForComputeEnvironments: ['validateForComputeEnvironments'],
};
Properties
Name | Type | Description |
---|---|---|
connection | string | The type of the connection. Currently, these types are supported:. |
athena | any | Connection properties specific to the Athena compute environment. |
authentication | IResolvable | Authentication | The authentication properties of the connection. |
connection | any | These key-value pairs define parameters for the connection. |
description? | string | The description of the connection. |
match | string[] | A list of criteria that can be used in selecting this connection. |
name? | string | The name of the connection. |
physical | IResolvable | Physical | The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection. |
python | any | Connection properties specific to the Python compute environment. |
spark | any | Connection properties specific to the Spark compute environment. |
validate | boolean | IResolvable | A flag to validate the credentials during create connection. |
validate | string[] | The compute environments that the specified connection properties are validated against. |
connectionType
Type:
string
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
) 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.
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 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.
MONGODB
Connections use the following ConnectionParameters.
- Required:
CONNECTION_URL
. - Required: All of (
USERNAME
,PASSWORD
) orSECRET_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
) 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 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 connection in 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 .
athenaProperties?
Type:
any
(optional)
Connection properties specific to the Athena compute environment.
authenticationConfiguration?
Type:
IResolvable
|
Authentication
(optional)
The authentication properties of the connection.
connectionProperties?
Type:
any
(optional)
These key-value pairs define parameters for the connection.
description?
Type:
string
(optional)
The description of the connection.
matchCriteria?
Type:
string[]
(optional)
A list of criteria that can be used in selecting this connection.
name?
Type:
string
(optional)
The name of the connection.
physicalConnectionRequirements?
Type:
IResolvable
|
Physical
(optional)
The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup
, that are needed to successfully make this connection.
pythonProperties?
Type:
any
(optional)
Connection properties specific to the Python compute environment.
sparkProperties?
Type:
any
(optional)
Connection properties specific to the Spark compute environment.
validateCredentials?
Type:
boolean |
IResolvable
(optional)
A flag to validate the credentials during create connection.
Default is true.
validateForComputeEnvironments?
Type:
string[]
(optional)
The compute environments that the specified connection properties are validated against.