ConnectionOptions

class aws_cdk.aws_glue_alpha.ConnectionOptions(*, connection_name=None, description=None, match_criteria=None, properties=None, secret=None, security_groups=None, subnet=None, vpc=None, vpc_subnets=None)

Bases: object

(experimental) Base Connection Options.

Parameters:

  • connection_name (Optional[str]) – (experimental) The name of the connection. Default: cloudformation generated name

  • description (Optional[str]) – (experimental) The description of the connection. Default: no description

  • match_criteria (Optional[Sequence[str]]) – (experimental) 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

  • properties (Optional[Mapping[str, str]]) – (experimental) Key-Value pairs that define parameters for the connection. Default: empty properties

  • secret (Optional[ISecretRef]) – (experimental) 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]]) – (experimental) The list of security groups needed to successfully make this connection e.g. to successfully connect to VPC. Default: no security group

  • subnet (Optional[ISubnet]) – (experimental) 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. Default: - no subnet, unless vpc is provided

  • vpc (Optional[IVpc]) – (experimental) 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. Default: - no VPC, the subnet is taken from subnet if provided

  • vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – (experimental) 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. Default: - private subnets

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

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

# secret_ref: interfaces_secretsmanager.ISecretRef
# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet
# subnet_filter: ec2.SubnetFilter
# vpc: ec2.Vpc

connection_options = glue_alpha.ConnectionOptions(
    connection_name="connectionName",
    description="description",
    match_criteria=["matchCriteria"],
    properties={
        "properties_key": "properties"
    },
    secret=secret_ref,
    security_groups=[security_group],
    subnet=subnet,
    vpc=vpc,
    vpc_subnets=ec2.SubnetSelection(
        availability_zones=["availabilityZones"],
        one_per_az=False,
        subnet_filters=[subnet_filter],
        subnet_group_name="subnetGroupName",
        subnets=[subnet],
        subnet_type=ec2.SubnetType.PRIVATE_ISOLATED
    )
)

Attributes

connection_name

(experimental) The name of the connection.

Default:

cloudformation generated name

Stability:

experimental

description

(experimental) The description of the connection.

Default:

no description

Stability:

experimental

match_criteria

(experimental) 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

Stability:

experimental

properties

(experimental) 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

Stability:

experimental

secret

(experimental) 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

Stability:

experimental

security_groups

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

Default:

no security group

Stability:

experimental

subnet

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

Default:

  • no subnet, unless vpc is provided

Stability:

experimental

Type:

(experimental) The VPC subnet to connect to resources within a VPC. See more at https

vpc

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

Default:

  • no VPC, the subnet is taken from subnet if provided

Stability:

experimental

vpc_subnets

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

Default:

  • private subnets

Stability:

experimental