Skip to content
v2.273.0

ConnectionProps Struct ​

Construction properties for Connection.

Example ​

ts
declare const securityGroup: ec2.SecurityGroup;
declare const vpc: ec2.Vpc;
new glue.Connection(this, 'MyConnection', {
  type: glue.ConnectionType.NETWORK,
  securityGroups: [securityGroup],
  // vpcSubnets is optional - defaults to private subnets
  network: glue.ConnectionNetwork.vpc(vpc, { subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }),
});

Properties ​

connectionNamestringconnection_namestrconnectionNameStringConnectionNamestringConnectionName*string= cloudformation generated name#
The name of the connection.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#
The description of the connection.
matchCriteriastring[]match_criteriatyping.List[str]matchCriteriaList<String>MatchCriteriastring[]MatchCriteria*[]*string= no match criteria#
A list of criteria that can be used in selecting this connection.
networkConnectionNetworknetworkConnectionNetworknetworkConnectionNetworkNetworkConnectionNetworkNetworkConnectionNetwork= 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{ [key: string]: string }propertiestyping.Mapping[str, str]propertiesMap<String, String>PropertiesIDictionary<string, string>Properties*map[string]*string= empty properties#
Key-Value pairs that define parameters for the connection.
secretISecretRefsecretISecretRefsecretISecretRefSecretISecretRefSecretISecretRef= no secret; any credentials must …#
A reference to a Secrets Manager secret holding the credentials for this connection.
notes · default

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.

Default: no secret; any credentials must be supplied via properties

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup= no security group#
The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC.
The type of the connection.

Used as props by ​