ConnectionOptions

class aws_cdk.aws_glue.ConnectionOptions(*, connection_name=None, description=None, match_criteria=None, network=None, properties=None, secret=None, security_groups=None)

Bases: object

Base Connection Options.

Parameters:

connection_name (Optional[str]) – The name of the connection. Default: cloudformation generated name
description (Optional[str]) – The description of the connection. Default: no description
match_criteria (Optional[Sequence[str]]) – 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
network (Optional[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. Build it with ConnectionNetwork.subnet(subnet) to pin a specific subnet, or ConnectionNetwork.vpc(vpc, vpcSubnets?) to let the CDK select one. Default: - no VPC network placement
properties (Optional[Mapping[str, str]]) – Key-Value pairs that define parameters for the connection. Default: empty properties
secret (Optional[ISecretRef]) – 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. Default: - no secret; any credentials must be supplied via properties
security_groups (Optional[Sequence[ISecurityGroup]]) – The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC. Default: no security group

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
from aws_cdk import aws_glue as glue
from aws_cdk.interfaces import aws_secretsmanager as interfaces_secretsmanager

# connection_network: glue.ConnectionNetwork
# secret_ref: interfaces_secretsmanager.ISecretRef
# security_group: ec2.SecurityGroup

connection_options = glue.ConnectionOptions(
    connection_name="connectionName",
    description="description",
    match_criteria=["matchCriteria"],
    network=connection_network,
    properties={
        "properties_key": "properties"
    },
    secret=secret_ref,
    security_groups=[security_group]
)

Attributes

connection_name

The name of the connection.

Default:: cloudformation generated name

description

The description of the connection.

Default:: no description

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

Default:: no match criteria

network

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

Default:

no VPC network placement

Type:

The VPC network placement for this connection, so it can reach resources inside a VPC. See more at https

properties

Key-Value pairs that define parameters for the connection.

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

secret

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.

Default:

no secret; any credentials must be supplied via properties

security_groups

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

Default:: no security group