interface ConnectionOptions 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Glue.Alpha.ConnectionOptions`
Go	`github.com/aws/aws-cdk-go/awscdkgluealpha/v2#ConnectionOptions`
Java	`software.amazon.awscdk.services.glue.alpha.ConnectionOptions`
Python	`aws_cdk.aws_glue_alpha.ConnectionOptions`
TypeScript (source)	`@aws-cdk/aws-glue-alpha` » `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 * as glue_alpha from '@aws-cdk/aws-glue-alpha';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_secretsmanager as interfaces_secretsmanager } from 'aws-cdk-lib/interfaces';

declare const secretRef: interfaces_secretsmanager.ISecretRef;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
declare const vpc: ec2.Vpc;
const connectionOptions: glue_alpha.ConnectionOptions = {
  connectionName: 'connectionName',
  description: 'description',
  matchCriteria: ['matchCriteria'],
  properties: {
    propertiesKey: 'properties',
  },
  secret: secretRef,
  securityGroups: [securityGroup],
  subnet: subnet,
  vpc: vpc,
  vpcSubnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.PRIVATE_ISOLATED,
  },
};

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.
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.
subnet?🔹	`ISubnet`	The VPC subnet to connect to resources within a VPC. See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html.
vpc?🔹	`IVpc`	The VPC to connect to resources within.
vpcSubnets?🔹	`SubnetSelection`	Which subnets of `vpc` to select the connection subnet from.

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.

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.

subnet?🔹

Type: ISubnet (optional, default: no subnet, unless vpc is provided)

The VPC subnet to connect to resources within a VPC. See more at https://docs.aws.amazon.com/glue/latest/dg/start-connecting.html.

Mutually exclusive with vpc: provide subnet to pin the connection to a specific subnet, or provide vpc (optionally with vpcSubnets) to let the CDK select one for you.

vpc?🔹

Type: IVpc (optional, default: no VPC, the subnet is taken from subnet if provided)

The VPC to connect to resources within.

When provided, the CDK selects a subnet from this VPC using vpcSubnets. A Glue connection targets a single subnet, so the first subnet of the selection is used.

Mutually exclusive with subnet.

vpcSubnets?🔹

Type: SubnetSelection (optional, default: private subnets)

Which subnets of vpc to select the connection subnet from.

Only used when vpc is provided. Since a Glue connection targets a single subnet, the first subnet of the selection is used.

AWS CDK

2.268.0