Connection

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

Bases: aws_cdk.core.Resource

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

Stability

experimental

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

Return type

str

connection_name

(experimental) The name of the connection.

Stability

experimental

Return type

str

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.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

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)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool