interface ConnectionOptions

Language	Type name
.NET	Amazon.CDK.AWS.Glue.ConnectionOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsglue#ConnectionOptions
Java	software.amazon.awscdk.services.glue.ConnectionOptions
Python	aws_cdk.aws_glue.ConnectionOptions
TypeScript (source)	aws-cdk-lib » aws_glue » ConnectionOptions

Base Connection Options.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_glue as glue } from 'aws-cdk-lib';
import { aws_secretsmanager as interfaces_secretsmanager } from 'aws-cdk-lib/interfaces';

declare const connectionNetwork: glue.ConnectionNetwork;
declare const secretRef: interfaces_secretsmanager.ISecretRef;
declare const securityGroup: ec2.SecurityGroup;
const connectionOptions: glue.ConnectionOptions = {
  connectionName: 'connectionName',
  description: 'description',
  matchCriteria: ['matchCriteria'],
  network: connectionNetwork,
  properties: {
    propertiesKey: 'properties',
  },
  secret: secretRef,
  securityGroups: [securityGroup],
};

Properties

Name	Type	Description
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.
network?	ConnectionNetwork	The VPC network placement for this connection, so it can reach resources inside a VPC. See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html.
properties?	{ [string]: string }	Key-Value pairs that define parameters for the connection.
secret?	ISecretRef	A reference to a Secrets Manager secret holding the credentials for this connection.
securityGroups?	ISecurityGroup[]	The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.

---

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

---

network?

Type: ConnectionNetwork (optional, default: no VPC network placement)

The VPC network placement for this connection, so it can reach resources inside a VPC. See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html.

Build it with ConnectionNetwork.subnet(subnet) to pin a specific subnet, or ConnectionNetwork.vpc(vpc, vpcSubnets?) to let the CDK select one.

---

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

---

secret?

Type: ISecretRef (optional, default: no secret; any credentials must be supplied via properties)

A reference to a Secrets Manager secret holding the credentials for this connection.

The secret is referenced through the connection's SECRET_ID property, so Glue reads the credentials at runtime and the secret value never appears in the synthesized template. Prefer this over placing credentials directly in properties. Accepts any secretsmanager.ISecret.

---

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.