CfnConnectionPropsMixin

class aws_cdk.mixins_preview.aws_glue.mixins.CfnConnectionPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::Glue::Connection resource specifies an AWS Glue connection to a data source.

For more information, see Adding a Connection to Your Data Store and Connection Structure in the AWS Glue Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html

CloudformationResource:

AWS::Glue::Connection

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

# athena_properties: Any
# connection_properties: Any
# custom_authentication_credentials: Any
# python_properties: Any
# spark_properties: Any
# token_url_parameters_map: Any

cfn_connection_props_mixin = glue_mixins.CfnConnectionPropsMixin(glue_mixins.CfnConnectionMixinProps(
    catalog_id="catalogId",
    connection_input=glue_mixins.CfnConnectionPropsMixin.ConnectionInputProperty(
        athena_properties=athena_properties,
        authentication_configuration=glue_mixins.CfnConnectionPropsMixin.AuthenticationConfigurationInputProperty(
            authentication_type="authenticationType",
            basic_authentication_credentials=glue_mixins.CfnConnectionPropsMixin.BasicAuthenticationCredentialsProperty(
                password="password",
                username="username"
            ),
            custom_authentication_credentials=custom_authentication_credentials,
            kms_key_arn="kmsKeyArn",
            o_auth2_properties=glue_mixins.CfnConnectionPropsMixin.OAuth2PropertiesInputProperty(
                authorization_code_properties=glue_mixins.CfnConnectionPropsMixin.AuthorizationCodePropertiesProperty(
                    authorization_code="authorizationCode",
                    redirect_uri="redirectUri"
                ),
                o_auth2_client_application=glue_mixins.CfnConnectionPropsMixin.OAuth2ClientApplicationProperty(
                    aws_managed_client_application_reference="awsManagedClientApplicationReference",
                    user_managed_client_application_client_id="userManagedClientApplicationClientId"
                ),
                o_auth2_credentials=glue_mixins.CfnConnectionPropsMixin.OAuth2CredentialsProperty(
                    access_token="accessToken",
                    jwt_token="jwtToken",
                    refresh_token="refreshToken",
                    user_managed_client_application_client_secret="userManagedClientApplicationClientSecret"
                ),
                o_auth2_grant_type="oAuth2GrantType",
                token_url="tokenUrl",
                token_url_parameters_map=token_url_parameters_map
            ),
            secret_arn="secretArn"
        ),
        connection_properties=connection_properties,
        connection_type="connectionType",
        description="description",
        match_criteria=["matchCriteria"],
        name="name",
        physical_connection_requirements=glue_mixins.CfnConnectionPropsMixin.PhysicalConnectionRequirementsProperty(
            availability_zone="availabilityZone",
            security_group_id_list=["securityGroupIdList"],
            subnet_id="subnetId"
        ),
        python_properties=python_properties,
        spark_properties=spark_properties,
        validate_credentials=False,
        validate_for_compute_environments=["validateForComputeEnvironments"]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Glue::Connection.

Parameters:

  • props (Union[CfnConnectionMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['catalogId', 'connectionInput']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

AuthenticationConfigurationInputProperty

class CfnConnectionPropsMixin.AuthenticationConfigurationInputProperty(*, authentication_type=None, basic_authentication_credentials=None, custom_authentication_credentials=None, kms_key_arn=None, o_auth2_properties=None, secret_arn=None)

Bases: object

A structure containing the authentication configuration in the CreateConnection request.

Parameters:

  • authentication_type (Optional[str]) – A structure containing the authentication configuration in the CreateConnection request.

  • basic_authentication_credentials (Union[IResolvable, BasicAuthenticationCredentialsProperty, Dict[str, Any], None]) – The credentials used when the authentication type is basic authentication.

  • custom_authentication_credentials (Any) – The credentials used when the authentication type is custom authentication.

  • kms_key_arn (Optional[str]) – The ARN of the KMS key used to encrypt the connection. Only taken an as input in the request and stored in the Secret Manager.

  • o_auth2_properties (Union[IResolvable, OAuth2PropertiesInputProperty, Dict[str, Any], None]) – The properties for OAuth2 authentication in the CreateConnection request.

  • secret_arn (Optional[str]) – The secret manager ARN to store credentials in the CreateConnection request.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

# custom_authentication_credentials: Any
# token_url_parameters_map: Any

authentication_configuration_input_property = glue_mixins.CfnConnectionPropsMixin.AuthenticationConfigurationInputProperty(
    authentication_type="authenticationType",
    basic_authentication_credentials=glue_mixins.CfnConnectionPropsMixin.BasicAuthenticationCredentialsProperty(
        password="password",
        username="username"
    ),
    custom_authentication_credentials=custom_authentication_credentials,
    kms_key_arn="kmsKeyArn",
    o_auth2_properties=glue_mixins.CfnConnectionPropsMixin.OAuth2PropertiesInputProperty(
        authorization_code_properties=glue_mixins.CfnConnectionPropsMixin.AuthorizationCodePropertiesProperty(
            authorization_code="authorizationCode",
            redirect_uri="redirectUri"
        ),
        o_auth2_client_application=glue_mixins.CfnConnectionPropsMixin.OAuth2ClientApplicationProperty(
            aws_managed_client_application_reference="awsManagedClientApplicationReference",
            user_managed_client_application_client_id="userManagedClientApplicationClientId"
        ),
        o_auth2_credentials=glue_mixins.CfnConnectionPropsMixin.OAuth2CredentialsProperty(
            access_token="accessToken",
            jwt_token="jwtToken",
            refresh_token="refreshToken",
            user_managed_client_application_client_secret="userManagedClientApplicationClientSecret"
        ),
        o_auth2_grant_type="oAuth2GrantType",
        token_url="tokenUrl",
        token_url_parameters_map=token_url_parameters_map
    ),
    secret_arn="secretArn"
)

Attributes

authentication_type

A structure containing the authentication configuration in the CreateConnection request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-authenticationtype

basic_authentication_credentials

The credentials used when the authentication type is basic authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-basicauthenticationcredentials

custom_authentication_credentials

The credentials used when the authentication type is custom authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-customauthenticationcredentials

kms_key_arn

The ARN of the KMS key used to encrypt the connection.

Only taken an as input in the request and stored in the Secret Manager.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-kmskeyarn

o_auth2_properties

The properties for OAuth2 authentication in the CreateConnection request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-oauth2properties

secret_arn

The secret manager ARN to store credentials in the CreateConnection request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authenticationconfigurationinput.html#cfn-glue-connection-authenticationconfigurationinput-secretarn

AuthorizationCodePropertiesProperty

class CfnConnectionPropsMixin.AuthorizationCodePropertiesProperty(*, authorization_code=None, redirect_uri=None)

Bases: object

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type workflow.

Parameters:

  • authorization_code (Optional[str]) – An authorization code to be used in the third leg of the AUTHORIZATION_CODE grant workflow. This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.

  • redirect_uri (Optional[str]) – The redirect URI where the user gets redirected to by authorization server when issuing an authorization code. The URI is subsequently used when the authorization code is exchanged for an access token.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

authorization_code_properties_property = glue_mixins.CfnConnectionPropsMixin.AuthorizationCodePropertiesProperty(
    authorization_code="authorizationCode",
    redirect_uri="redirectUri"
)

Attributes

authorization_code

An authorization code to be used in the third leg of the AUTHORIZATION_CODE grant workflow.

This is a single-use code which becomes invalid once exchanged for an access token, thus it is acceptable to have this value as a request parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authorizationcodeproperties.html#cfn-glue-connection-authorizationcodeproperties-authorizationcode

redirect_uri

The redirect URI where the user gets redirected to by authorization server when issuing an authorization code.

The URI is subsequently used when the authorization code is exchanged for an access token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-authorizationcodeproperties.html#cfn-glue-connection-authorizationcodeproperties-redirecturi

BasicAuthenticationCredentialsProperty

class CfnConnectionPropsMixin.BasicAuthenticationCredentialsProperty(*, password=None, username=None)

Bases: object

For supplying basic auth credentials when not providing a SecretArn value.

Parameters:

  • password (Optional[str]) – The password to connect to the data source.

  • username (Optional[str]) – The username to connect to the data source.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

basic_authentication_credentials_property = glue_mixins.CfnConnectionPropsMixin.BasicAuthenticationCredentialsProperty(
    password="password",
    username="username"
)

Attributes

password

The password to connect to the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-basicauthenticationcredentials.html#cfn-glue-connection-basicauthenticationcredentials-password

username

The username to connect to the data source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-basicauthenticationcredentials.html#cfn-glue-connection-basicauthenticationcredentials-username

ConnectionInputProperty

class CfnConnectionPropsMixin.ConnectionInputProperty(*, athena_properties=None, authentication_configuration=None, connection_properties=None, connection_type=None, description=None, match_criteria=None, name=None, physical_connection_requirements=None, python_properties=None, spark_properties=None, validate_credentials=None, validate_for_compute_environments=None)

Bases: object

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

Parameters:

  • athena_properties (Any) – Connection properties specific to the Athena compute environment.

  • authentication_configuration (Union[IResolvable, AuthenticationConfigurationInputProperty, Dict[str, Any], None]) – The authentication properties of the connection.

  • connection_properties (Any) – These key-value pairs define parameters for the connection.

  • connection_type (Optional[str]) – 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 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 .

  • description (Optional[str]) – The description of the connection.

  • match_criteria (Optional[Sequence[str]]) – A list of criteria that can be used in selecting this connection.

  • name (Optional[str]) – The name of the connection.

  • physical_connection_requirements (Union[IResolvable, PhysicalConnectionRequirementsProperty, Dict[str, Any], None]) – The physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.

  • python_properties (Any) – Connection properties specific to the Python compute environment.

  • spark_properties (Any) – Connection properties specific to the Spark compute environment.

  • validate_credentials (Union[bool, IResolvable, None]) – A flag to validate the credentials during create connection. Default is true.

  • validate_for_compute_environments (Optional[Sequence[str]]) – The compute environments that the specified connection properties are validated against.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

# athena_properties: Any
# connection_properties: Any
# custom_authentication_credentials: Any
# python_properties: Any
# spark_properties: Any
# token_url_parameters_map: Any

connection_input_property = glue_mixins.CfnConnectionPropsMixin.ConnectionInputProperty(
    athena_properties=athena_properties,
    authentication_configuration=glue_mixins.CfnConnectionPropsMixin.AuthenticationConfigurationInputProperty(
        authentication_type="authenticationType",
        basic_authentication_credentials=glue_mixins.CfnConnectionPropsMixin.BasicAuthenticationCredentialsProperty(
            password="password",
            username="username"
        ),
        custom_authentication_credentials=custom_authentication_credentials,
        kms_key_arn="kmsKeyArn",
        o_auth2_properties=glue_mixins.CfnConnectionPropsMixin.OAuth2PropertiesInputProperty(
            authorization_code_properties=glue_mixins.CfnConnectionPropsMixin.AuthorizationCodePropertiesProperty(
                authorization_code="authorizationCode",
                redirect_uri="redirectUri"
            ),
            o_auth2_client_application=glue_mixins.CfnConnectionPropsMixin.OAuth2ClientApplicationProperty(
                aws_managed_client_application_reference="awsManagedClientApplicationReference",
                user_managed_client_application_client_id="userManagedClientApplicationClientId"
            ),
            o_auth2_credentials=glue_mixins.CfnConnectionPropsMixin.OAuth2CredentialsProperty(
                access_token="accessToken",
                jwt_token="jwtToken",
                refresh_token="refreshToken",
                user_managed_client_application_client_secret="userManagedClientApplicationClientSecret"
            ),
            o_auth2_grant_type="oAuth2GrantType",
            token_url="tokenUrl",
            token_url_parameters_map=token_url_parameters_map
        ),
        secret_arn="secretArn"
    ),
    connection_properties=connection_properties,
    connection_type="connectionType",
    description="description",
    match_criteria=["matchCriteria"],
    name="name",
    physical_connection_requirements=glue_mixins.CfnConnectionPropsMixin.PhysicalConnectionRequirementsProperty(
        availability_zone="availabilityZone",
        security_group_id_list=["securityGroupIdList"],
        subnet_id="subnetId"
    ),
    python_properties=python_properties,
    spark_properties=spark_properties,
    validate_credentials=False,
    validate_for_compute_environments=["validateForComputeEnvironments"]
)

Attributes

athena_properties

Connection properties specific to the Athena compute environment.

See:

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

authentication_configuration

The authentication properties of the connection.

See:

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

connection_properties

These key-value pairs define parameters for the connection.

See:

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

connection_type

.

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

See:

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

Type:

The type of the connection. Currently, these types are supported

description

The description of the connection.

See:

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

match_criteria

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

See:

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

name

The name of the connection.

See:

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

physical_connection_requirements

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

See:

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

python_properties

Connection properties specific to the Python compute environment.

See:

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

spark_properties

Connection properties specific to the Spark compute environment.

See:

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

validate_credentials

A flag to validate the credentials during create connection.

Default is true.

See:

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

validate_for_compute_environments

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

See:

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

OAuth2ClientApplicationProperty

class CfnConnectionPropsMixin.OAuth2ClientApplicationProperty(*, aws_managed_client_application_reference=None, user_managed_client_application_client_id=None)

Bases: object

The OAuth2 client app used for the connection.

Parameters:

  • aws_managed_client_application_reference (Optional[str]) – The reference to the SaaS-side client app that is AWS managed.

  • user_managed_client_application_client_id (Optional[str]) – The client application clientID if the ClientAppType is USER_MANAGED .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

o_auth2_client_application_property = glue_mixins.CfnConnectionPropsMixin.OAuth2ClientApplicationProperty(
    aws_managed_client_application_reference="awsManagedClientApplicationReference",
    user_managed_client_application_client_id="userManagedClientApplicationClientId"
)

Attributes

aws_managed_client_application_reference

The reference to the SaaS-side client app that is AWS managed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2clientapplication.html#cfn-glue-connection-oauth2clientapplication-awsmanagedclientapplicationreference

user_managed_client_application_client_id

The client application clientID if the ClientAppType is USER_MANAGED .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2clientapplication.html#cfn-glue-connection-oauth2clientapplication-usermanagedclientapplicationclientid

OAuth2CredentialsProperty

class CfnConnectionPropsMixin.OAuth2CredentialsProperty(*, access_token=None, jwt_token=None, refresh_token=None, user_managed_client_application_client_secret=None)

Bases: object

The credentials used when the authentication type is OAuth2 authentication.

Parameters:

  • access_token (Optional[str]) – The access token used when the authentication type is OAuth2.

  • jwt_token (Optional[str]) – The JSON Web Token (JWT) used when the authentication type is OAuth2.

  • refresh_token (Optional[str]) – The refresh token used when the authentication type is OAuth2.

  • user_managed_client_application_client_secret (Optional[str]) – The client application client secret if the client application is user managed.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

o_auth2_credentials_property = glue_mixins.CfnConnectionPropsMixin.OAuth2CredentialsProperty(
    access_token="accessToken",
    jwt_token="jwtToken",
    refresh_token="refreshToken",
    user_managed_client_application_client_secret="userManagedClientApplicationClientSecret"
)

Attributes

access_token

The access token used when the authentication type is OAuth2.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html#cfn-glue-connection-oauth2credentials-accesstoken

jwt_token

The JSON Web Token (JWT) used when the authentication type is OAuth2.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html#cfn-glue-connection-oauth2credentials-jwttoken

refresh_token

The refresh token used when the authentication type is OAuth2.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html#cfn-glue-connection-oauth2credentials-refreshtoken

user_managed_client_application_client_secret

The client application client secret if the client application is user managed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2credentials.html#cfn-glue-connection-oauth2credentials-usermanagedclientapplicationclientsecret

OAuth2PropertiesInputProperty

class CfnConnectionPropsMixin.OAuth2PropertiesInputProperty(*, authorization_code_properties=None, o_auth2_client_application=None, o_auth2_credentials=None, o_auth2_grant_type=None, token_url=None, token_url_parameters_map=None)

Bases: object

A structure containing properties for OAuth2 in the CreateConnection request.

Parameters:

  • authorization_code_properties (Union[IResolvable, AuthorizationCodePropertiesProperty, Dict[str, Any], None]) – The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

  • o_auth2_client_application (Union[IResolvable, OAuth2ClientApplicationProperty, Dict[str, Any], None]) – The client application type in the CreateConnection request. For example, AWS_MANAGED or USER_MANAGED .

  • o_auth2_credentials (Union[IResolvable, OAuth2CredentialsProperty, Dict[str, Any], None]) – The credentials used when the authentication type is OAuth2 authentication.

  • o_auth2_grant_type (Optional[str]) – The OAuth2 grant type in the CreateConnection request. For example, AUTHORIZATION_CODE , JWT_BEARER , or CLIENT_CREDENTIALS .

  • token_url (Optional[str]) – The URL of the provider’s authentication server, to exchange an authorization code for an access token.

  • token_url_parameters_map (Any) – A map of parameters that are added to the token GET request.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

# token_url_parameters_map: Any

o_auth2_properties_input_property = glue_mixins.CfnConnectionPropsMixin.OAuth2PropertiesInputProperty(
    authorization_code_properties=glue_mixins.CfnConnectionPropsMixin.AuthorizationCodePropertiesProperty(
        authorization_code="authorizationCode",
        redirect_uri="redirectUri"
    ),
    o_auth2_client_application=glue_mixins.CfnConnectionPropsMixin.OAuth2ClientApplicationProperty(
        aws_managed_client_application_reference="awsManagedClientApplicationReference",
        user_managed_client_application_client_id="userManagedClientApplicationClientId"
    ),
    o_auth2_credentials=glue_mixins.CfnConnectionPropsMixin.OAuth2CredentialsProperty(
        access_token="accessToken",
        jwt_token="jwtToken",
        refresh_token="refreshToken",
        user_managed_client_application_client_secret="userManagedClientApplicationClientSecret"
    ),
    o_auth2_grant_type="oAuth2GrantType",
    token_url="tokenUrl",
    token_url_parameters_map=token_url_parameters_map
)

Attributes

authorization_code_properties

The set of properties required for the the OAuth2 AUTHORIZATION_CODE grant type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-authorizationcodeproperties

o_auth2_client_application

The client application type in the CreateConnection request.

For example, AWS_MANAGED or USER_MANAGED .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-oauth2clientapplication

o_auth2_credentials

The credentials used when the authentication type is OAuth2 authentication.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-oauth2credentials

o_auth2_grant_type

The OAuth2 grant type in the CreateConnection request.

For example, AUTHORIZATION_CODE , JWT_BEARER , or CLIENT_CREDENTIALS .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-oauth2granttype

token_url

The URL of the provider’s authentication server, to exchange an authorization code for an access token.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-tokenurl

token_url_parameters_map

A map of parameters that are added to the token GET request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-oauth2propertiesinput.html#cfn-glue-connection-oauth2propertiesinput-tokenurlparametersmap

PhysicalConnectionRequirementsProperty

class CfnConnectionPropsMixin.PhysicalConnectionRequirementsProperty(*, availability_zone=None, security_group_id_list=None, subnet_id=None)

Bases: object

The OAuth client app in GetConnection response.

Parameters:

  • availability_zone (Optional[str]) – The connection’s Availability Zone.

  • security_group_id_list (Optional[Sequence[str]]) – The security group ID list used by the connection.

  • subnet_id (Optional[str]) – The subnet ID used by the connection.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_glue import mixins as glue_mixins

physical_connection_requirements_property = glue_mixins.CfnConnectionPropsMixin.PhysicalConnectionRequirementsProperty(
    availability_zone="availabilityZone",
    security_group_id_list=["securityGroupIdList"],
    subnet_id="subnetId"
)

Attributes

availability_zone

The connection’s Availability Zone.

See:

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

security_group_id_list

The security group ID list used by the connection.

See:

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

subnet_id

The subnet ID used by the connection.

See:

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