CfnConnection

class aws_cdk.aws_glue.CfnConnection(scope, id, *, catalog_id, connection_input)

Bases: CfnResource

A CloudFormation AWS::Glue::Connection.

The AWS::Glue::Connection resource specifies an AWS Glue connection to a data source. For more information, see Adding a Connection to Your Data Store and Connection Structure in the AWS Glue Developer Guide .

CloudformationResource:: AWS::Glue::Connection
Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html
ExampleMetadata:: fixture=_generated

Example:

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

# connection_properties: Any

cfn_connection = glue.CfnConnection(self, "MyCfnConnection",
    catalog_id="catalogId",
    connection_input=glue.CfnConnection.ConnectionInputProperty(
        connection_type="connectionType",

        # the properties below are optional
        connection_properties=connection_properties,
        description="description",
        match_criteria=["matchCriteria"],
        name="name",
        physical_connection_requirements=glue.CfnConnection.PhysicalConnectionRequirementsProperty(
            availability_zone="availabilityZone",
            security_group_id_list=["securityGroupIdList"],
            subnet_id="subnetId"
        )
    )
)

Create a new AWS::Glue::Connection.

Parameters:

scope (Construct) –
- scope in which this resource is defined.
id (str) –
- scoped id of the resource.
catalog_id (str) – The ID of the data catalog to create the catalog object in. Currently, this should be the AWS account ID. .. epigraph:: To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId .
connection_input (Union[IResolvable, ConnectionInputProperty, Dict[str, Any]]) – The connection that you want to create.

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_depends_on(target)

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.

Parameters:

target (CfnResource) –

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

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

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 resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

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

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

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Glue::Connection'

catalog_id

The ID of the data catalog to create the catalog object in.

Currently, this should be the AWS account ID. .. epigraph:

To specify the account ID, you can use the ``Ref`` intrinsic function with the ``AWS::AccountId`` pseudo parameter. For example: ``!Ref AWS::AccountId`` .

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

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

cfn_resource_type: AWS resource type.

connection_input

The connection that you want to create.

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

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.

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 construct tree node associated with this construct.

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

stack

The stack in which this element is defined.

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

Static Methods

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(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

ConnectionInputProperty

class CfnConnection.ConnectionInputProperty(*, connection_type, connection_properties=None, description=None, match_criteria=None, name=None, physical_connection_requirements=None)

Bases: object

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

Parameters:

connection_type (str) – The type of the connection. Currently, these types are supported:. - JDBC - Designates a connection to a database through Java Database Connectivity (JDBC). JDBC Connections use the following ConnectionParameters. - Required: All of ( HOST , PORT , JDBC_ENGINE ) or JDBC_CONNECTION_URL . - Required: All of ( USERNAME , PASSWORD ) or SECRET_ID . - Optional: JDBC_ENFORCE_SSL , CUSTOM_JDBC_CERT , CUSTOM_JDBC_CERT_STRING , SKIP_CUSTOM_JDBC_CERT_VALIDATION . These parameters are used to configure SSL with JDBC. - KAFKA - Designates a connection to an Apache Kafka streaming platform. KAFKA Connections use the following ConnectionParameters. - Required: KAFKA_BOOTSTRAP_SERVERS . - Optional: KAFKA_SSL_ENABLED , KAFKA_CUSTOM_CERT , KAFKA_SKIP_CUSTOM_CERT_VALIDATION . These parameters are used to configure SSL with KAFKA . - Optional: KAFKA_CLIENT_KEYSTORE , KAFKA_CLIENT_KEYSTORE_PASSWORD , KAFKA_CLIENT_KEY_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD . These parameters are used to configure TLS client configuration with SSL in KAFKA . - Optional: KAFKA_SASL_MECHANISM . Can be specified as SCRAM-SHA-512 , GSSAPI , or AWS_MSK_IAM . - Optional: KAFKA_SASL_SCRAM_USERNAME , KAFKA_SASL_SCRAM_PASSWORD , ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD . These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA . - Optional: KAFKA_SASL_GSSAPI_KEYTAB , KAFKA_SASL_GSSAPI_KRB5_CONF , KAFKA_SASL_GSSAPI_SERVICE , KAFKA_SASL_GSSAPI_PRINCIPAL . These parameters are used to configure SASL/GSSAPI authentication with KAFKA . - MONGODB - Designates a connection to a MongoDB document database. MONGODB Connections use the following ConnectionParameters. - Required: CONNECTION_URL . - Required: All of ( USERNAME , PASSWORD ) or SECRET_ID . - NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC). NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. - MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue . MARKETPLACE Connections use the following ConnectionParameters. - Required: CONNECTOR_TYPE , CONNECTOR_URL , CONNECTOR_CLASS_NAME , CONNECTION_URL . - Required for JDBC CONNECTOR_TYPE connections: All of ( USERNAME , PASSWORD ) or SECRET_ID . - CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue . SFTP is not supported. For more information about how optional ConnectionProperties are used to configure features in AWS Glue , consult AWS Glue connection properties . For more information about how optional ConnectionProperties are used to configure features in AWS Glue Studio, consult Using connectors and connections .
connection_properties (Optional[Any]) – These key-value pairs define parameters for the connection.
description (Optional[str]) – The description of the connection.
match_criteria (Optional[Sequence[str]]) – A list of criteria that can be used in selecting this connection.
name (Optional[str]) – The name of the connection. Connection will not function as expected without a name.
physical_connection_requirements (Union[IResolvable, PhysicalConnectionRequirementsProperty, Dict[str, Any], None]) – A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup , that are needed to successfully make this connection.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

# connection_properties: Any

connection_input_property = glue.CfnConnection.ConnectionInputProperty(
    connection_type="connectionType",

    # the properties below are optional
    connection_properties=connection_properties,
    description="description",
    match_criteria=["matchCriteria"],
    name="name",
    physical_connection_requirements=glue.CfnConnection.PhysicalConnectionRequirementsProperty(
        availability_zone="availabilityZone",
        security_group_id_list=["securityGroupIdList"],
        subnet_id="subnetId"
    )
)

Attributes

connection_properties

These key-value pairs define parameters for the connection.

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

connection_type

.

JDBC - Designates a connection to a database through Java Database Connectivity (JDBC).

JDBC Connections use the following ConnectionParameters.

Required: All of ( HOST , PORT , JDBC_ENGINE ) or JDBC_CONNECTION_URL .
Required: All of ( USERNAME , PASSWORD ) or SECRET_ID .
Optional: JDBC_ENFORCE_SSL , CUSTOM_JDBC_CERT , CUSTOM_JDBC_CERT_STRING , SKIP_CUSTOM_JDBC_CERT_VALIDATION . These parameters are used to configure SSL with JDBC.
KAFKA - Designates a connection to an Apache Kafka streaming platform.

KAFKA Connections use the following ConnectionParameters.

Required: KAFKA_BOOTSTRAP_SERVERS .
Optional: KAFKA_SSL_ENABLED , KAFKA_CUSTOM_CERT , KAFKA_SKIP_CUSTOM_CERT_VALIDATION . These parameters are used to configure SSL with KAFKA .
Optional: KAFKA_CLIENT_KEYSTORE , KAFKA_CLIENT_KEYSTORE_PASSWORD , KAFKA_CLIENT_KEY_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD , ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD . These parameters are used to configure TLS client configuration with SSL in KAFKA .
Optional: KAFKA_SASL_MECHANISM . Can be specified as SCRAM-SHA-512 , GSSAPI , or AWS_MSK_IAM .
Optional: KAFKA_SASL_SCRAM_USERNAME , KAFKA_SASL_SCRAM_PASSWORD , ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD . These parameters are used to configure SASL/SCRAM-SHA-512 authentication with KAFKA .
Optional: KAFKA_SASL_GSSAPI_KEYTAB , KAFKA_SASL_GSSAPI_KRB5_CONF , KAFKA_SASL_GSSAPI_SERVICE , KAFKA_SASL_GSSAPI_PRINCIPAL . These parameters are used to configure SASL/GSSAPI authentication with KAFKA .
MONGODB - Designates a connection to a MongoDB document database.

MONGODB Connections use the following ConnectionParameters.

Required: CONNECTION_URL .
Required: All of ( USERNAME , PASSWORD ) or SECRET_ID .
NETWORK - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC).

NETWORK Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements.

MARKETPLACE - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue .

MARKETPLACE Connections use the following ConnectionParameters.

Required: CONNECTOR_TYPE , CONNECTOR_URL , CONNECTOR_CLASS_NAME , CONNECTION_URL .
Required for JDBC CONNECTOR_TYPE connections: All of ( USERNAME , PASSWORD ) or SECRET_ID .
CUSTOM - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue .

SFTP is not supported.

For more information about how optional ConnectionProperties are used to configure features in AWS Glue , consult AWS Glue connection properties .

For more information about how optional ConnectionProperties are used to configure features in AWS Glue Studio, consult Using connectors and connections .

Link:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectiontype
Type:: The type of the connection. Currently, these types are supported

description

The description of the connection.

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

match_criteria

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

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

name

The name of the connection.

Connection will not function as expected without a name.

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

physical_connection_requirements

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

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

PhysicalConnectionRequirementsProperty

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

Bases: object

Specifies the physical requirements for a connection.

Parameters:

availability_zone (Optional[str]) – The connection’s Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.
security_group_id_list (Optional[Sequence[str]]) – The security group ID list used by the connection.
subnet_id (Optional[str]) – The subnet ID used by the connection.

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

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

Attributes

availability_zone

The connection’s Availability Zone.

This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

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

security_group_id_list

The security group ID list used by the connection.

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

subnet_id

The subnet ID used by the connection.

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