CfnConnectionType

class aws_cdk.aws_glue.CfnConnectionType(scope, id, *, connection_type, rest_configuration, connection_properties=None, connector_authentication_configuration=None, description=None, integration_type=None, tags=None)

Bases: CfnResource

Registers a custom connection type in Glue based on the configuration provided.

This enables customers to configure custom connectors for any data source with REST-based APIs.

See:

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

CloudformationResource:

AWS::Glue::ConnectionType

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 = glue.CfnConnectionType(self, "MyCfnConnectionType",
    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"
    )]
)

Create a new AWS::Glue::ConnectionType.

Parameters:

• scope (Construct) – Scope in which this resource is defined.

• id (str) – Construct identifier for this resource (unique in its scope).

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

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

• key (str)

• value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

• path (str) –

  • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

• value (Any) –

  • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

• property_path (str) – The path of the property.

• value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:

• target (CfnResource)

• reason (Optional[str])

Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

• The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

• policy (Optional[RemovalPolicy])

• apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

• default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)

Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

• attribute_name (str) – The name of the attribute.

• type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:

List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Deprecated:

Use removeResourceDependency instead

Stability:

deprecated

Return type:

None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

• target (CfnResource) – The dependency to replace.

• new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Glue::ConnectionType'

attr_connection_type_arn

The Amazon Resource Name (ARN) of the registered connection type.

CloudformationAttribute:

ConnectionTypeArn

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

connection_properties

Configuration that defines the base URL and additional request parameters needed during connection creation.

connection_type

The name of the connection type.

connection_type_ref

A reference to a ConnectionType resource.

connector_authentication_configuration

Configuration that defines supported authentication types and required properties.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

A description of the connection type.

env

integration_type

The integration type for the connection.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

rest_configuration

Configuration for HTTP request and response handling.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tags to assign to the connection type.

Static Methods

classmethod arn_for_connection_type(resource)

Parameters:

resource (IConnectionTypeRef)

Return type:

str

classmethod is_cfn_connection_type(x)

Checks whether the given object is a CfnConnectionType.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

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

BasicAuthenticationPropertiesProperty

class CfnConnectionType.BasicAuthenticationPropertiesProperty(*, password=None, username=None)

Bases: object

Basic authentication configuration.

Parameters:

• password (Union[IResolvable, SecretConnectorPropertyProperty, Dict[str, Any], None]) – Defines a secret property configuration. SECRET-type properties cannot have DefaultValue or AllowedValues.

• username (Union[IResolvable, SecretConnectorPropertyProperty, Dict[str, Any], None]) – Defines a secret property configuration. SECRET-type properties cannot have DefaultValue or AllowedValues.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-basicauthenticationproperties.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 import aws_glue as glue

basic_authentication_properties_property = 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"
    )
)

Attributes

password

Defines a secret property configuration.

SECRET-type properties cannot have DefaultValue or AllowedValues.

See:

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

username

Defines a secret property configuration.

SECRET-type properties cannot have DefaultValue or AllowedValues.

See:

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

BetweenConfigurationProperty

class CfnConnectionType.BetweenConfigurationProperty(*, high_bound_key=None, low_bound_key=None, template=None)

Bases: object

Configuration that defines how BETWEEN range filter operations are translated into REST API request parameters.

Parameters:

• high_bound_key (Optional[str]) – The parameter name used for the upper bound value in a BETWEEN filter operation.

• low_bound_key (Optional[str]) – The parameter name used for the lower bound value in a BETWEEN filter operation.

• template (Optional[str]) – A template string for constructing the BETWEEN filter expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-betweenconfiguration.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 import aws_glue as glue

between_configuration_property = glue.CfnConnectionType.BetweenConfigurationProperty(
    high_bound_key="highBoundKey",
    low_bound_key="lowBoundKey",
    template="template"
)

Attributes

high_bound_key

The parameter name used for the upper bound value in a BETWEEN filter operation.

See:

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

low_bound_key

The parameter name used for the lower bound value in a BETWEEN filter operation.

See:

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

template

A template string for constructing the BETWEEN filter expression.

See:

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

ClientCredentialsPropertiesProperty

class CfnConnectionType.ClientCredentialsPropertiesProperty(*, client_id=None, client_secret=None, content_type=None, request_method=None, scope=None, token_url=None, token_url_parameters=None)

Bases: object

OAuth2 client credentials configuration.

Parameters:

• client_id (Union[IResolvable, SecretConnectorPropertyProperty, Dict[str, Any], None]) – Defines a secret property configuration. SECRET-type properties cannot have DefaultValue or AllowedValues.

• client_secret (Union[IResolvable, SecretConnectorPropertyProperty, Dict[str, Any], None]) – Defines a secret property configuration. SECRET-type properties cannot have DefaultValue or AllowedValues.

• content_type (Optional[str])

• request_method (Optional[str])

• scope (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• token_url (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• token_url_parameters (Union[IResolvable, Sequence[Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any]]], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-clientcredentialsproperties.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 import aws_glue as glue

client_credentials_properties_property = 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"
    )]
)

Attributes

client_id

Defines a secret property configuration.

SECRET-type properties cannot have DefaultValue or AllowedValues.

See:

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

client_secret

Defines a secret property configuration.

SECRET-type properties cannot have DefaultValue or AllowedValues.

See:

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

content_type

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

Type:

see

request_method

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

Type:

see

scope

Defines a property configuration for connection types.

See:

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

token_url

Defines a property configuration for connection types.

See:

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

token_url_parameters

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

Type:

see

ConnectionPropertiesConfigurationProperty

class CfnConnectionType.ConnectionPropertiesConfigurationProperty(*, additional_request_parameters=None, url=None)

Bases: object

Configuration that defines the base URL and additional request parameters needed during connection creation.

Parameters:

• additional_request_parameters (Union[IResolvable, Sequence[Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any]]], None]) – Key-value pairs of additional request parameters.

• url (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectionpropertiesconfiguration.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 import aws_glue as glue

connection_properties_configuration_property = 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"
    )
)

Attributes

additional_request_parameters

Key-value pairs of additional request parameters.

See:

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

url

Defines a property configuration for connection types.

See:

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

ConnectorAuthenticationConfigurationProperty

class CfnConnectionType.ConnectorAuthenticationConfigurationProperty(*, authentication_types, basic_authentication_properties=None, custom_authentication_properties=None, o_auth2_properties=None)

Bases: object

Configuration that defines supported authentication types and required properties.

Parameters:

• authentication_types (Sequence[str]) – A list of authentication types supported.

• basic_authentication_properties (Union[IResolvable, BasicAuthenticationPropertiesProperty, Dict[str, Any], None]) – Basic authentication configuration.

• custom_authentication_properties (Union[IResolvable, CustomAuthenticationPropertiesProperty, Dict[str, Any], None]) – Custom authentication configuration.

• o_auth2_properties (Union[IResolvable, ConnectorOAuth2PropertiesProperty, Dict[str, Any], None]) – OAuth2 configuration container.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectorauthenticationconfiguration.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 import aws_glue as glue

connector_authentication_configuration_property = 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"
            )]
        )
    )
)

Attributes

authentication_types

A list of authentication types supported.

See:

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

basic_authentication_properties

Basic authentication configuration.

See:

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

custom_authentication_properties

Custom authentication configuration.

See:

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

o_auth2_properties

OAuth2 configuration container.

See:

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

ConnectorAuthorizationCodePropertiesProperty

class CfnConnectionType.ConnectorAuthorizationCodePropertiesProperty(*, authorization_code=None, authorization_code_url=None, client_id=None, client_secret=None, content_type=None, prompt=None, redirect_uri=None, request_method=None, scope=None, token_url=None, token_url_parameters=None)

Bases: object

OAuth2 authorization code configuration.

Parameters:

• authorization_code (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• authorization_code_url (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• client_id (Union[IResolvable, SecretConnectorPropertyProperty, Dict[str, Any], None]) – Defines a secret property configuration. SECRET-type properties cannot have DefaultValue or AllowedValues.

• client_secret (Union[IResolvable, SecretConnectorPropertyProperty, Dict[str, Any], None]) – Defines a secret property configuration. SECRET-type properties cannot have DefaultValue or AllowedValues.

• content_type (Optional[str])

• prompt (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• redirect_uri (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• request_method (Optional[str])

• scope (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• token_url (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• token_url_parameters (Union[IResolvable, Sequence[Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any]]], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectorauthorizationcodeproperties.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 import aws_glue as glue

connector_authorization_code_properties_property = 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"
    )]
)

Attributes

authorization_code

Defines a property configuration for connection types.

See:

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

authorization_code_url

Defines a property configuration for connection types.

See:

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

client_id

Defines a secret property configuration.

SECRET-type properties cannot have DefaultValue or AllowedValues.

See:

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

client_secret

Defines a secret property configuration.

SECRET-type properties cannot have DefaultValue or AllowedValues.

See:

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

content_type

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

Type:

see

prompt

Defines a property configuration for connection types.

See:

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

redirect_uri

Defines a property configuration for connection types.

See:

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

request_method

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

Type:

see

scope

Defines a property configuration for connection types.

See:

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

token_url

Defines a property configuration for connection types.

See:

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

token_url_parameters

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

Type:

see

ConnectorOAuth2PropertiesProperty

class CfnConnectionType.ConnectorOAuth2PropertiesProperty(*, o_auth2_grant_type, authorization_code_properties=None, client_credentials_properties=None, jwt_bearer_properties=None)

Bases: object

OAuth2 configuration container.

Parameters:

• o_auth2_grant_type (str) – The OAuth2 grant type to use.

• authorization_code_properties (Union[IResolvable, ConnectorAuthorizationCodePropertiesProperty, Dict[str, Any], None]) – OAuth2 authorization code configuration.

• client_credentials_properties (Union[IResolvable, ClientCredentialsPropertiesProperty, Dict[str, Any], None]) – OAuth2 client credentials configuration.

• jwt_bearer_properties (Union[IResolvable, JWTBearerPropertiesProperty, Dict[str, Any], None]) – JWT bearer token configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectoroauth2properties.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 import aws_glue as glue

connector_o_auth2_properties_property = 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"
        )]
    )
)

Attributes

authorization_code_properties

OAuth2 authorization code configuration.

See:

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

client_credentials_properties

OAuth2 client credentials configuration.

See:

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

jwt_bearer_properties

JWT bearer token configuration.

See:

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

o_auth2_grant_type

The OAuth2 grant type to use.

See:

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

ConnectorPropertyProperty

class CfnConnectionType.ConnectorPropertyProperty(*, name, property_type, required, allowed_values=None, default_value=None, key_override=None, property_location=None)

Bases: object

Defines a property configuration for connection types.

Parameters:

• name (str) – The name of the property.

• property_type (str) – The data type of this property.

• required (Union[bool, IResolvable]) – Indicates whether the property is required.

• allowed_values (Optional[Sequence[str]]) – A list of allowed values for the property.

• default_value (Optional[str]) – The default value for the property.

• key_override (Optional[str]) – A key name to use when sending this property in API requests.

• property_location (Optional[str]) – Specifies where this property should be included in REST requests.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-connectorproperty.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 import aws_glue as glue

connector_property_property = 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"
)

Attributes

allowed_values

A list of allowed values for the property.

See:

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

default_value

The default value for the property.

See:

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

key_override

A key name to use when sending this property in API requests.

See:

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

name

The name of the property.

See:

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

property_location

Specifies where this property should be included in REST requests.

See:

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

property_type

The data type of this property.

See:

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

required

Indicates whether the property is required.

See:

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

CursorConfigurationProperty

class CfnConnectionType.CursorConfigurationProperty(*, next_page, limit_parameter=None)

Bases: object

Cursor-based pagination configuration.

Parameters:

• next_page (Union[IResolvable, ExtractedParameterProperty, Dict[str, Any]]) – Parameter extraction configuration.

• limit_parameter (Union[IResolvable, ExtractedParameterProperty, Dict[str, Any], None]) – Parameter extraction configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-cursorconfiguration.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 import aws_glue as glue

cursor_configuration_property = 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"
        )
    )
)

Attributes

limit_parameter

Parameter extraction configuration.

See:

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

next_page

Parameter extraction configuration.

See:

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

CustomAuthenticationPropertiesProperty

class CfnConnectionType.CustomAuthenticationPropertiesProperty(*, authentication_parameters)

Bases: object

Custom authentication configuration.

Parameters:

authentication_parameters (Union[IResolvable, Sequence[Union[IResolvable, SecretConnectorPropertyProperty, Dict[str, Any]]]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-customauthenticationproperties.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 import aws_glue as glue

custom_authentication_properties_property = 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"
    )]
)

Attributes

authentication_parameters

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

Type:

see

EntityConfigurationProperty

class CfnConnectionType.EntityConfigurationProperty(*, schema=None, source_configuration=None)

Bases: object

Configuration for interacting with a specific data entity.

Parameters:

• schema (Union[IResolvable, Mapping[str, Union[IResolvable, FieldDefinitionProperty, Dict[str, Any]]], None]) – The schema definition for this entity.

• source_configuration (Union[IResolvable, SourceConfigurationProperty, Dict[str, Any], None]) – Configuration that defines how to make requests to endpoints.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-entityconfiguration.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 import aws_glue as glue

entity_configuration_property = 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"
        )
    )
)

Attributes

schema

The schema definition for this entity.

See:

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

source_configuration

Configuration that defines how to make requests to endpoints.

See:

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

ExtractedParameterProperty

class CfnConnectionType.ExtractedParameterProperty(*, default_value=None, key=None, property_location=None, value=None)

Bases: object

Parameter extraction configuration.

Parameters:

• default_value (Optional[str]) – The default value.

• key (Optional[str]) – The parameter key name.

• property_location (Optional[str]) – Specifies where to place the parameter in requests.

• value (Union[IResolvable, ResponseExtractionMappingProperty, Dict[str, Any], None]) – Defines how to extract values from HTTP responses.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-extractedparameter.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 import aws_glue as glue

extracted_parameter_property = glue.CfnConnectionType.ExtractedParameterProperty(
    default_value="defaultValue",
    key="key",
    property_location="propertyLocation",
    value=glue.CfnConnectionType.ResponseExtractionMappingProperty(
        content_path="contentPath",
        header_key="headerKey"
    )
)

Attributes

default_value

The default value.

See:

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

key

The parameter key name.

See:

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

property_location

Specifies where to place the parameter in requests.

See:

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

value

Defines how to extract values from HTTP responses.

See:

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

FieldDefinitionProperty

class CfnConnectionType.FieldDefinitionProperty(*, field_data_type, name, filter_overrides=None, is_nullable=None, is_orderable=None, is_partitionable=None, is_queryable=None, response_date_format=None)

Bases: object

Defines a field in an entity schema.

Parameters:

• field_data_type (str) – The data type of the field.

• name (str) – The name of the field.

• filter_overrides (Union[IResolvable, FilterOverridesProperty, Dict[str, Any], None]) – Configuration that defines per-field overrides for filter behavior, allowing individual fields to customize how filter operations are applied.

• is_nullable (Union[bool, IResolvable, None]) – Indicates whether this field can contain null values.

• is_orderable (Union[bool, IResolvable, None]) – Indicates whether this field can be used for ordering results.

• is_partitionable (Union[bool, IResolvable, None]) – Indicates whether this field can be used for partitioning queries to the data source.

• is_queryable (Union[bool, IResolvable, None]) – Indicates whether this field can be used in filter predicates when querying data.

• response_date_format (Optional[str]) – The format pattern for parsing date values from API responses. Accepts Java DateTimeFormatter patterns, EPOCH_SECONDS, or EPOCH_MILLIS.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-fielddefinition.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 import aws_glue as glue

field_definition_property = 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"
)

Attributes

field_data_type

The data type of the field.

See:

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

filter_overrides

Configuration that defines per-field overrides for filter behavior, allowing individual fields to customize how filter operations are applied.

See:

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

is_nullable

Indicates whether this field can contain null values.

See:

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

is_orderable

Indicates whether this field can be used for ordering results.

See:

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

is_partitionable

Indicates whether this field can be used for partitioning queries to the data source.

See:

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

is_queryable

Indicates whether this field can be used in filter predicates when querying data.

See:

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

name

The name of the field.

See:

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

response_date_format

The format pattern for parsing date values from API responses.

Accepts Java DateTimeFormatter patterns, EPOCH_SECONDS, or EPOCH_MILLIS.

See:

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

FilterConfigurationProperty

class CfnConnectionType.FilterConfigurationProperty(*, filter_mode, between_configuration=None, date_time_format=None, filter_string_configuration=None, operator_mappings=None, strip_quotes=None)

Bases: object

Configuration that defines how filter predicates are applied to REST API requests, supporting both query parameter and filter string strategies.

Parameters:

• filter_mode (str) – The strategy for applying filters to requests.

• between_configuration (Union[IResolvable, BetweenConfigurationProperty, Dict[str, Any], None]) – Configuration that defines how BETWEEN range filter operations are translated into REST API request parameters.

• date_time_format (Optional[str]) – The global date and time format for filter expressions.

• filter_string_configuration (Union[IResolvable, FilterStringConfigurationProperty, Dict[str, Any], None]) – Configuration for constructing filter expression strings when using the FILTER_STRING filter mode.

• operator_mappings (Union[IResolvable, Mapping[str, str], None]) – A map of logical filter operators to their API-specific string representations.

• strip_quotes (Union[bool, IResolvable, None]) – Indicates whether surrounding double quotes should be stripped from filter values before processing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-filterconfiguration.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 import aws_glue as glue

filter_configuration_property = 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
)

Attributes

between_configuration

Configuration that defines how BETWEEN range filter operations are translated into REST API request parameters.

See:

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

date_time_format

The global date and time format for filter expressions.

See:

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

filter_mode

The strategy for applying filters to requests.

See:

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

filter_string_configuration

Configuration for constructing filter expression strings when using the FILTER_STRING filter mode.

See:

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

operator_mappings

A map of logical filter operators to their API-specific string representations.

See:

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

strip_quotes

Indicates whether surrounding double quotes should be stripped from filter values before processing.

See:

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

FilterOverridesProperty

class CfnConnectionType.FilterOverridesProperty(*, between_configuration=None, date_time_format=None, field_name=None, operator_mappings=None)

Bases: object

Configuration that defines per-field overrides for filter behavior, allowing individual fields to customize how filter operations are applied.

Parameters:

• between_configuration (Union[IResolvable, BetweenConfigurationProperty, Dict[str, Any], None]) – Configuration that defines how BETWEEN range filter operations are translated into REST API request parameters.

• date_time_format (Optional[str]) – The date and time format for filter expressions on this field, overriding the global DateTimeFormat.

• field_name (Optional[str]) – An override for the field name to use in filter expressions, if different from the schema field name.

• operator_mappings (Union[IResolvable, Mapping[str, str], None]) – A map of logical filter operators to their field-specific API representations, overriding the global operator mappings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-filteroverrides.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 import aws_glue as glue

filter_overrides_property = 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"
    }
)

Attributes

between_configuration

Configuration that defines how BETWEEN range filter operations are translated into REST API request parameters.

See:

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

date_time_format

The date and time format for filter expressions on this field, overriding the global DateTimeFormat.

See:

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

field_name

An override for the field name to use in filter expressions, if different from the schema field name.

See:

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

operator_mappings

A map of logical filter operators to their field-specific API representations, overriding the global operator mappings.

See:

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

FilterStringConfigurationProperty

class CfnConnectionType.FilterStringConfigurationProperty(*, query_parameter_name, quote_character=None, quote_string_values=None)

Bases: object

Configuration for constructing filter expression strings when using the FILTER_STRING filter mode.

Parameters:

• query_parameter_name (str) – The query parameter name used to send the constructed filter expression string in API requests.

• quote_character (Optional[str]) – The character used to quote values when QuoteStringValues is true. Defaults to double quotes if not specified.

• quote_string_values (Union[bool, IResolvable, None]) – Indicates whether string and date values should be wrapped with a quote character in the filter expression.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-filterstringconfiguration.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 import aws_glue as glue

filter_string_configuration_property = glue.CfnConnectionType.FilterStringConfigurationProperty(
    query_parameter_name="queryParameterName",

    # the properties below are optional
    quote_character="quoteCharacter",
    quote_string_values=False
)

Attributes

query_parameter_name

The query parameter name used to send the constructed filter expression string in API requests.

See:

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

quote_character

The character used to quote values when QuoteStringValues is true.

Defaults to double quotes if not specified.

See:

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

quote_string_values

Indicates whether string and date values should be wrapped with a quote character in the filter expression.

See:

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

JWTBearerPropertiesProperty

class CfnConnectionType.JWTBearerPropertiesProperty(*, content_type=None, jwt_token=None, request_method=None, token_url=None, token_url_parameters=None)

Bases: object

JWT bearer token configuration.

Parameters:

• content_type (Optional[str])

• jwt_token (Union[IResolvable, SecretConnectorPropertyProperty, Dict[str, Any], None]) – Defines a secret property configuration. SECRET-type properties cannot have DefaultValue or AllowedValues.

• request_method (Optional[str])

• token_url (Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any], None]) – Defines a property configuration for connection types.

• token_url_parameters (Union[IResolvable, Sequence[Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any]]], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-jwtbearerproperties.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 import aws_glue as glue

j_wt_bearer_properties_property = 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"
    )]
)

Attributes

content_type

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

Type:

see

jwt_token

Defines a secret property configuration.

SECRET-type properties cannot have DefaultValue or AllowedValues.

See:

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

request_method

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

Type:

see

token_url

Defines a property configuration for connection types.

See:

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

token_url_parameters

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

Type:

see

OffsetConfigurationProperty

class CfnConnectionType.OffsetConfigurationProperty(*, limit_parameter, offset_parameter)

Bases: object

Offset-based pagination configuration.

Parameters:

• limit_parameter (Union[IResolvable, ExtractedParameterProperty, Dict[str, Any]]) – Parameter extraction configuration.

• offset_parameter (Union[IResolvable, ExtractedParameterProperty, Dict[str, Any]]) – Parameter extraction configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-offsetconfiguration.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 import aws_glue as glue

offset_configuration_property = 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"
        )
    )
)

Attributes

limit_parameter

Parameter extraction configuration.

See:

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

offset_parameter

Parameter extraction configuration.

See:

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

PaginationConfigurationProperty

class CfnConnectionType.PaginationConfigurationProperty(*, cursor_configuration=None, offset_configuration=None)

Bases: object

Configuration for handling paginated responses.

Parameters:

• cursor_configuration (Union[IResolvable, CursorConfigurationProperty, Dict[str, Any], None]) – Cursor-based pagination configuration.

• offset_configuration (Union[IResolvable, OffsetConfigurationProperty, Dict[str, Any], None]) – Offset-based pagination configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-paginationconfiguration.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 import aws_glue as glue

pagination_configuration_property = 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"
            )
        )
    )
)

Attributes

cursor_configuration

Cursor-based pagination configuration.

See:

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

offset_configuration

Offset-based pagination configuration.

See:

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

ResponseConfigurationProperty

class CfnConnectionType.ResponseConfigurationProperty(*, result_path, error_path=None)

Bases: object

Configuration for parsing JSON responses from REST API calls.

Parameters:

• result_path (str) – JSON path expression for result data location.

• error_path (Optional[str]) – JSON path expression for error information location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-responseconfiguration.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 import aws_glue as glue

response_configuration_property = glue.CfnConnectionType.ResponseConfigurationProperty(
    result_path="resultPath",

    # the properties below are optional
    error_path="errorPath"
)

Attributes

error_path

JSON path expression for error information location.

See:

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

result_path

JSON path expression for result data location.

See:

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

ResponseExtractionMappingProperty

class CfnConnectionType.ResponseExtractionMappingProperty(*, content_path=None, header_key=None)

Bases: object

Defines how to extract values from HTTP responses.

Parameters:

• content_path (Optional[str]) – A JSON path expression to extract a value from response body.

• header_key (Optional[str]) – The name of an HTTP response header from which to extract the value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-responseextractionmapping.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 import aws_glue as glue

response_extraction_mapping_property = glue.CfnConnectionType.ResponseExtractionMappingProperty(
    content_path="contentPath",
    header_key="headerKey"
)

Attributes

content_path

A JSON path expression to extract a value from response body.

See:

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

header_key

The name of an HTTP response header from which to extract the value.

See:

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

RestConfigurationProperty

class CfnConnectionType.RestConfigurationProperty(*, entity_configurations=None, global_source_configuration=None, validation_endpoint_configuration=None)

Bases: object

Configuration for HTTP request and response handling.

Parameters:

• entity_configurations (Union[IResolvable, Mapping[str, Union[IResolvable, EntityConfigurationProperty, Dict[str, Any]]], None]) – A map of entity configurations.

• global_source_configuration (Union[IResolvable, SourceConfigurationProperty, Dict[str, Any], None]) – Configuration that defines how to make requests to endpoints.

• validation_endpoint_configuration (Union[IResolvable, ValidationEndpointConfigurationProperty, Dict[str, Any], None]) – Configuration for the validation endpoint. Only supports RequestMethod and RequestPath.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-restconfiguration.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 import aws_glue as glue

rest_configuration_property = 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"
    )
)

Attributes

entity_configurations

A map of entity configurations.

See:

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

global_source_configuration

Configuration that defines how to make requests to endpoints.

See:

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

validation_endpoint_configuration

Configuration for the validation endpoint.

Only supports RequestMethod and RequestPath.

See:

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

SecretConnectorPropertyProperty

class CfnConnectionType.SecretConnectorPropertyProperty(*, name, property_type, required, key_override=None, property_location=None)

Bases: object

Defines a secret property configuration.

SECRET-type properties cannot have DefaultValue or AllowedValues.

Parameters:

• name (str) – The name of the property.

• property_type (str) – The data type of this property. Must be SECRET for secret properties.

• required (Union[bool, IResolvable]) – Indicates whether the property is required.

• key_override (Optional[str]) – A key name to use when sending this property in API requests.

• property_location (Optional[str]) – Specifies where this property should be included in REST requests.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-secretconnectorproperty.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 import aws_glue as glue

secret_connector_property_property = glue.CfnConnectionType.SecretConnectorPropertyProperty(
    name="name",
    property_type="propertyType",
    required=False,

    # the properties below are optional
    key_override="keyOverride",
    property_location="propertyLocation"
)

Attributes

key_override

A key name to use when sending this property in API requests.

See:

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

name

The name of the property.

See:

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

property_location

Specifies where this property should be included in REST requests.

See:

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

property_type

The data type of this property.

Must be SECRET for secret properties.

See:

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

required

Indicates whether the property is required.

See:

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

SourceConfigurationProperty

class CfnConnectionType.SourceConfigurationProperty(*, filter_configuration=None, pagination_configuration=None, request_method=None, request_parameters=None, request_path=None, response_configuration=None)

Bases: object

Configuration that defines how to make requests to endpoints.

Parameters:

• filter_configuration (Union[IResolvable, FilterConfigurationProperty, Dict[str, Any], None]) – Configuration that defines how filter predicates are applied to REST API requests, supporting both query parameter and filter string strategies.

• pagination_configuration (Union[IResolvable, PaginationConfigurationProperty, Dict[str, Any], None]) – Configuration for handling paginated responses.

• request_method (Optional[str]) – The HTTP method to use.

• request_parameters (Union[IResolvable, Sequence[Union[IResolvable, ConnectorPropertyProperty, Dict[str, Any]]], None]) – Request parameters configuration.

• request_path (Optional[str]) – The URL path for the REST endpoint.

• response_configuration (Union[IResolvable, ResponseConfigurationProperty, Dict[str, Any], None]) – Configuration for parsing JSON responses from REST API calls.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-sourceconfiguration.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 import aws_glue as glue

source_configuration_property = 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"
    )
)

Attributes

filter_configuration

Configuration that defines how filter predicates are applied to REST API requests, supporting both query parameter and filter string strategies.

See:

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

pagination_configuration

Configuration for handling paginated responses.

See:

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

request_method

The HTTP method to use.

See:

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

request_parameters

Request parameters configuration.

See:

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

request_path

The URL path for the REST endpoint.

See:

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

response_configuration

Configuration for parsing JSON responses from REST API calls.

See:

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

ValidationEndpointConfigurationProperty

class CfnConnectionType.ValidationEndpointConfigurationProperty(*, request_method=None, request_path=None)

Bases: object

Configuration for the validation endpoint.

Only supports RequestMethod and RequestPath.

Parameters:

• request_method (Optional[str]) – The HTTP method to use.

• request_path (Optional[str]) – The URL path for the REST endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connectiontype-validationendpointconfiguration.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 import aws_glue as glue

validation_endpoint_configuration_property = glue.CfnConnectionType.ValidationEndpointConfigurationProperty(
    request_method="requestMethod",
    request_path="requestPath"
)

Attributes

request_method

The HTTP method to use.

See:

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

request_path

The URL path for the REST endpoint.

See:

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