class Connection (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Glue.Alpha.Connection
Go	github.com/aws/aws-cdk-go/awscdkgluealpha/v2#Connection
Java	software.amazon.awscdk.services.glue.alpha.Connection
Python	aws_cdk.aws_glue_alpha.Connection
TypeScript (source)	@aws-cdk/aws-glue-alpha » Connection

Implements IConstruct, IDependable, IResource, IConnection

An AWS Glue connection to a data source.

Example

declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
new glue.Connection(this, 'MyConnection', {
  type: glue.ConnectionType.NETWORK,
  // The security groups granting AWS Glue inbound access to the data source within the VPC
  securityGroups: [securityGroup],
  // The VPC subnet which contains the data source
  subnet,
});

Initializer

new Connection(scope: Construct, id: string, props: ConnectionProps)

Parameters

• scope Construct
• id string
• props ConnectionProps

Construct Props

Name	Type	Description
type🔹	ConnectionType	The type of the connection.
connectionName?🔹	string	The name of the connection.
description?🔹	string	The description of the connection.
matchCriteria?🔹	string[]	A list of criteria that can be used in selecting this connection.
properties?🔹	{ [string]: string }	Key-Value pairs that define parameters for the connection.
securityGroups?🔹	ISecurityGroup[]	The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.
subnet?🔹	ISubnet	The VPC subnet to connect to resources within a VPC.

---

type🔹

Type: ConnectionType

The type of the connection.

---

connectionName?🔹

Type: string (optional, default: cloudformation generated name)

The name of the connection.

---

description?🔹

Type: string (optional, default: no description)

The description of the connection.

---

matchCriteria?🔹

Type: string[] (optional, default: no match criteria)

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

---

properties?🔹

Type: { [string]: string } (optional, default: empty properties)

Key-Value pairs that define parameters for the connection.

See also: https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-connect.html

---

securityGroups?🔹

Type: ISecurityGroup[] (optional, default: no security group)

The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.

---

subnet?🔹

Type: ISubnet (optional, default: no subnet)

The VPC subnet to connect to resources within a VPC.

See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html.

Properties

Name	Type	Description
connectionArn🔹	string	The ARN of the connection.
connectionName🔹	string	The name of the connection.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.

---

connectionArn🔹

Type: string

The ARN of the connection.

---

connectionName🔹

Type: string

The name of the connection.

---

env🔹

Type: ResourceEnvironment

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🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
addProperty(key, value)🔹	Add additional connection parameters.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromConnectionArn(scope, id, connectionArn)🔹	Creates a Connection construct that represents an external connection.
static fromConnectionName(scope, id, connectionName)🔹	Creates a Connection construct that represents an external connection.

---

addProperty(key, value)🔹

public addProperty(key: string, value: string): void

Parameters

• key string — parameter key.
• value string — parameter value.

Add additional connection parameters.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromConnectionArn(scope, id, connectionArn)🔹

public static fromConnectionArn(scope: Construct, id: string, connectionArn: string): IConnection

Parameters

• scope Construct — The scope creating construct (usually this).
• id string — The construct's id.
• connectionArn string — arn of external connection.

Returns

• IConnection

Creates a Connection construct that represents an external connection.

---

static fromConnectionName(scope, id, connectionName)🔹

public static fromConnectionName(scope: Construct, id: string, connectionName: string): IConnection

Parameters

• scope Construct — The scope creating construct (usually this).
• id string — The construct's id.
• connectionName string — name of external connection.

Returns

• IConnection

Creates a Connection construct that represents an external connection.