ConnectionOptions¶

class aws_cdk.aws_glue.ConnectionOptions(*, connection_name=None, description=None, match_criteria=None, properties=None, security_groups=None, subnet=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
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. Default: no subnet

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_ec2 as ec2
import aws_cdk.aws_glue as glue

# security_group: ec2.SecurityGroup
# subnet: ec2.Subnet

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

Attributes

connection_name¶

(experimental) The name of the connection.

Default: cloudformation generated name
Stability: experimental
Return type: Optional[str]

description¶

(experimental) The description of the connection.

Default: no description
Stability: experimental
Return type: Optional[str]

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
Return type: Optional[List[str]]

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
Return type: Optional[Mapping[str, str]]

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
Return type: Optional[List[ISecurityGroup]]

subnet¶

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

Default: no subnet
Stability: experimental
Return type: Optional[ISubnet]