CfnConnectionTypeProps

class aws_cdk.aws_glue.CfnConnectionTypeProps(*, connection_type, rest_configuration, connection_properties=None, connector_authentication_configuration=None, description=None, integration_type=None, tags=None)

Bases: object

Properties for defining a CfnConnectionType.

Parameters:

connection_type (str) – The name of the connection type. Must be prefixed with REST-.
rest_configuration (Union[IResolvable, RestConfigurationProperty, Dict[str, Any]]) – Configuration for HTTP request and response handling.
connection_properties (Union[IResolvable, ConnectionPropertiesConfigurationProperty, Dict[str, Any], None]) – Configuration that defines the base URL and additional request parameters needed during connection creation.
connector_authentication_configuration (Union[IResolvable, ConnectorAuthenticationConfigurationProperty, Dict[str, Any], None]) – Configuration that defines supported authentication types and required properties.
description (Optional[str]) – A description of the connection type.
integration_type (Optional[str]) – The integration type for the connection. Currently only REST is supported.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the connection type.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_connection_type_props = glue.CfnConnectionTypeProps(
    connection_type="connectionType",
    rest_configuration=glue.CfnConnectionType.RestConfigurationProperty(
        entity_configurations={
            "entity_configurations_key": glue.CfnConnectionType.EntityConfigurationProperty(
                schema={
                    "schema_key": glue.CfnConnectionType.FieldDefinitionProperty(
                        field_data_type="fieldDataType",
                        name="name",

                        # the properties below are optional
                        filter_overrides=glue.CfnConnectionType.FilterOverridesProperty(
                            between_configuration=glue.CfnConnectionType.BetweenConfigurationProperty(
                                high_bound_key="highBoundKey",
                                low_bound_key="lowBoundKey",
                                template="template"
                            ),
                            date_time_format="dateTimeFormat",
                            field_name="fieldName",
                            operator_mappings={
                                "operator_mappings_key": "operatorMappings"
                            }
                        ),
                        is_nullable=False,
                        is_orderable=False,
                        is_partitionable=False,
                        is_queryable=False,
                        response_date_format="responseDateFormat"
                    )
                },
                source_configuration=glue.CfnConnectionType.SourceConfigurationProperty(
                    filter_configuration=glue.CfnConnectionType.FilterConfigurationProperty(
                        filter_mode="filterMode",

                        # the properties below are optional
                        between_configuration=glue.CfnConnectionType.BetweenConfigurationProperty(
                            high_bound_key="highBoundKey",
                            low_bound_key="lowBoundKey",
                            template="template"
                        ),
                        date_time_format="dateTimeFormat",
                        filter_string_configuration=glue.CfnConnectionType.FilterStringConfigurationProperty(
                            query_parameter_name="queryParameterName",

                            # the properties below are optional
                            quote_character="quoteCharacter",
                            quote_string_values=False
                        ),
                        operator_mappings={
                            "operator_mappings_key": "operatorMappings"
                        },
                        strip_quotes=False
                    ),
                    pagination_configuration=glue.CfnConnectionType.PaginationConfigurationProperty(
                        cursor_configuration=glue.CfnConnectionType.CursorConfigurationProperty(
                            next_page=glue.CfnConnectionType.ExtractedParameterProperty(
                                default_value="defaultValue",
                                key="key",
                                property_location="propertyLocation",
                                value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
                                    content_path="contentPath",
                                    header_key="headerKey"
                                )
                            ),

                            # the properties below are optional
                            limit_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
                                default_value="defaultValue",
                                key="key",
                                property_location="propertyLocation",
                                value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
                                    content_path="contentPath",
                                    header_key="headerKey"
                                )
                            )
                        ),
                        offset_configuration=glue.CfnConnectionType.OffsetConfigurationProperty(
                            limit_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
                                default_value="defaultValue",
                                key="key",
                                property_location="propertyLocation",
                                value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
                                    content_path="contentPath",
                                    header_key="headerKey"
                                )
                            ),
                            offset_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
                                default_value="defaultValue",
                                key="key",
                                property_location="propertyLocation",
                                value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
                                    content_path="contentPath",
                                    header_key="headerKey"
                                )
                            )
                        )
                    ),
                    request_method="requestMethod",
                    request_parameters=[glue.CfnConnectionType.ConnectorPropertyProperty(
                        name="name",
                        property_type="propertyType",
                        required=False,

                        # the properties below are optional
                        allowed_values=["allowedValues"],
                        default_value="defaultValue",
                        key_override="keyOverride",
                        property_location="propertyLocation"
                    )],
                    request_path="requestPath",
                    response_configuration=glue.CfnConnectionType.ResponseConfigurationProperty(
                        result_path="resultPath",

                        # the properties below are optional
                        error_path="errorPath"
                    )
                )
            )
        },
        global_source_configuration=glue.CfnConnectionType.SourceConfigurationProperty(
            filter_configuration=glue.CfnConnectionType.FilterConfigurationProperty(
                filter_mode="filterMode",

                # the properties below are optional
                between_configuration=glue.CfnConnectionType.BetweenConfigurationProperty(
                    high_bound_key="highBoundKey",
                    low_bound_key="lowBoundKey",
                    template="template"
                ),
                date_time_format="dateTimeFormat",
                filter_string_configuration=glue.CfnConnectionType.FilterStringConfigurationProperty(
                    query_parameter_name="queryParameterName",

                    # the properties below are optional
                    quote_character="quoteCharacter",
                    quote_string_values=False
                ),
                operator_mappings={
                    "operator_mappings_key": "operatorMappings"
                },
                strip_quotes=False
            ),
            pagination_configuration=glue.CfnConnectionType.PaginationConfigurationProperty(
                cursor_configuration=glue.CfnConnectionType.CursorConfigurationProperty(
                    next_page=glue.CfnConnectionType.ExtractedParameterProperty(
                        default_value="defaultValue",
                        key="key",
                        property_location="propertyLocation",
                        value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
                            content_path="contentPath",
                            header_key="headerKey"
                        )
                    ),

                    # the properties below are optional
                    limit_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
                        default_value="defaultValue",
                        key="key",
                        property_location="propertyLocation",
                        value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
                            content_path="contentPath",
                            header_key="headerKey"
                        )
                    )
                ),
                offset_configuration=glue.CfnConnectionType.OffsetConfigurationProperty(
                    limit_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
                        default_value="defaultValue",
                        key="key",
                        property_location="propertyLocation",
                        value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
                            content_path="contentPath",
                            header_key="headerKey"
                        )
                    ),
                    offset_parameter=glue.CfnConnectionType.ExtractedParameterProperty(
                        default_value="defaultValue",
                        key="key",
                        property_location="propertyLocation",
                        value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
                            content_path="contentPath",
                            header_key="headerKey"
                        )
                    )
                )
            ),
            request_method="requestMethod",
            request_parameters=[glue.CfnConnectionType.ConnectorPropertyProperty(
                name="name",
                property_type="propertyType",
                required=False,

                # the properties below are optional
                allowed_values=["allowedValues"],
                default_value="defaultValue",
                key_override="keyOverride",
                property_location="propertyLocation"
            )],
            request_path="requestPath",
            response_configuration=glue.CfnConnectionType.ResponseConfigurationProperty(
                result_path="resultPath",

                # the properties below are optional
                error_path="errorPath"
            )
        ),
        validation_endpoint_configuration=glue.CfnConnectionType.ValidationEndpointConfigurationProperty(
            request_method="requestMethod",
            request_path="requestPath"
        )
    ),

    # the properties below are optional
    connection_properties=glue.CfnConnectionType.ConnectionPropertiesConfigurationProperty(
        additional_request_parameters=[glue.CfnConnectionType.ConnectorPropertyProperty(
            name="name",
            property_type="propertyType",
            required=False,

            # the properties below are optional
            allowed_values=["allowedValues"],
            default_value="defaultValue",
            key_override="keyOverride",
            property_location="propertyLocation"
        )],
        url=glue.CfnConnectionType.ConnectorPropertyProperty(
            name="name",
            property_type="propertyType",
            required=False,

            # the properties below are optional
            allowed_values=["allowedValues"],
            default_value="defaultValue",
            key_override="keyOverride",
            property_location="propertyLocation"
        )
    ),
    connector_authentication_configuration=glue.CfnConnectionType.ConnectorAuthenticationConfigurationProperty(
        authentication_types=["authenticationTypes"],

        # the properties below are optional
        basic_authentication_properties=glue.CfnConnectionType.BasicAuthenticationPropertiesProperty(
            password=glue.CfnConnectionType.SecretConnectorPropertyProperty(
                name="name",
                property_type="propertyType",
                required=False,

                # the properties below are optional
                key_override="keyOverride",
                property_location="propertyLocation"
            ),
            username=glue.CfnConnectionType.SecretConnectorPropertyProperty(
                name="name",
                property_type="propertyType",
                required=False,

                # the properties below are optional
                key_override="keyOverride",
                property_location="propertyLocation"
            )
        ),
        custom_authentication_properties=glue.CfnConnectionType.CustomAuthenticationPropertiesProperty(
            authentication_parameters=[glue.CfnConnectionType.SecretConnectorPropertyProperty(
                name="name",
                property_type="propertyType",
                required=False,

                # the properties below are optional
                key_override="keyOverride",
                property_location="propertyLocation"
            )]
        ),
        o_auth2_properties=glue.CfnConnectionType.ConnectorOAuth2PropertiesProperty(
            o_auth2_grant_type="oAuth2GrantType",

            # the properties below are optional
            authorization_code_properties=glue.CfnConnectionType.ConnectorAuthorizationCodePropertiesProperty(
                authorization_code=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                authorization_code_url=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                client_id=glue.CfnConnectionType.SecretConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                client_secret=glue.CfnConnectionType.SecretConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                content_type="contentType",
                prompt=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                redirect_uri=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                request_method="requestMethod",
                scope=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                token_url=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                token_url_parameters=[glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                )]
            ),
            client_credentials_properties=glue.CfnConnectionType.ClientCredentialsPropertiesProperty(
                client_id=glue.CfnConnectionType.SecretConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                client_secret=glue.CfnConnectionType.SecretConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                content_type="contentType",
                request_method="requestMethod",
                scope=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                token_url=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                token_url_parameters=[glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                )]
            ),
            jwt_bearer_properties=glue.CfnConnectionType.JWTBearerPropertiesProperty(
                content_type="contentType",
                jwt_token=glue.CfnConnectionType.SecretConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                request_method="requestMethod",
                token_url=glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                ),
                token_url_parameters=[glue.CfnConnectionType.ConnectorPropertyProperty(
                    name="name",
                    property_type="propertyType",
                    required=False,

                    # the properties below are optional
                    allowed_values=["allowedValues"],
                    default_value="defaultValue",
                    key_override="keyOverride",
                    property_location="propertyLocation"
                )]
            )
        )
    ),
    description="description",
    integration_type="integrationType",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)