Connection

class aws_cdk.aws_glue_alpha.Connection(scope, id, *, type, connection_name=None, description=None, match_criteria=None, properties=None, security_groups=None, subnet=None)

Bases: Resource

(experimental) An AWS Glue connection to a data source.

Stability:: experimental
ExampleMetadata:: infused

Example:

# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet

glue.Connection(self, "MyConnection",
    type=glue.ConnectionType.NETWORK,
    # The security groups granting AWS Glue inbound access to the data source within the VPC
    security_groups=[security_group],
    # The VPC subnet which contains the data source
    subnet=subnet
)

Parameters:

scope (Construct) –
id (str) –
type (ConnectionType) – (experimental) The type of the connection.
connection_name (Optional[str]) – (experimental) The name of the connection. Default: cloudformation generated name
description (Optional[str]) – (experimental) The description of the connection. Default: no description
match_criteria (Optional[Sequence[str]]) – (experimental) A list of criteria that can be used in selecting this connection. This is useful for filtering the results of https://awscli.amazonaws.com/v2/documentation/api/latest/reference/glue/get-connections.html Default: no match criteria
properties (Optional[Mapping[str, str]]) – (experimental) Key-Value pairs that define parameters for the connection. Default: empty properties
security_groups (Optional[Sequence[ISecurityGroup]]) – (experimental) The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC. Default: no security group
subnet (Optional[ISubnet]) – (experimental) The VPC subnet to connect to resources within a VPC. See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html. Default: no subnet

Stability:

experimental

Methods

add_property(key, value)

(experimental) Add additional connection parameters.

Parameters:

key (str) – parameter key.
value (str) – parameter value.

Stability:

experimental

Return type:

None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

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 (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

connection_arn

(experimental) The ARN of the connection.

Stability:: experimental

connection_name

(experimental) The name of the connection.

Stability:: experimental

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node: The tree node.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_connection_arn(scope, id, connection_arn)

(experimental) Creates a Connection construct that represents an external connection.

Parameters:

scope (Construct) – The scope creating construct (usually this).
id (str) – The construct’s id.
connection_arn (str) – arn of external connection.

Stability:

experimental

Return type:

IConnection

classmethod from_connection_name(scope, id, connection_name)

(experimental) Creates a Connection construct that represents an external connection.

Parameters:

scope (Construct) – The scope creating construct (usually this).
id (str) – The construct’s id.
connection_name (str) – name of external connection.

Stability:

experimental

Return type:

IConnection

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.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool