Connection

Provides a Glue Connection resource.

Example Usage

Non-VPC Connection

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Glue.Connection("example", new Aws.Glue.ConnectionArgs
        {
            ConnectionProperties = 
            {
                { "JDBC_CONNECTION_URL", "jdbc:mysql://example.com/exampledatabase" },
                { "PASSWORD", "examplepassword" },
                { "USERNAME", "exampleusername" },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/glue"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := glue.NewConnection(ctx, "example", &glue.ConnectionArgs{
            ConnectionProperties: pulumi.StringMap{
                "JDBC_CONNECTION_URL": pulumi.String("jdbc:mysql://example.com/exampledatabase"),
                "PASSWORD":            pulumi.String("examplepassword"),
                "USERNAME":            pulumi.String("exampleusername"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.glue.Connection("example", connection_properties={
    "JDBC_CONNECTION_URL": "jdbc:mysql://example.com/exampledatabase",
    "PASSWORD": "examplepassword",
    "USERNAME": "exampleusername",
})

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.glue.Connection("example", {
    connectionProperties: {
        JDBC_CONNECTION_URL: "jdbc:mysql://example.com/exampledatabase",
        PASSWORD: "examplepassword",
        USERNAME: "exampleusername",
    },
});

Create a Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);

def Connection(resource_name, opts=None, catalog_id=None, connection_properties=None, connection_type=None, description=None, match_criterias=None, name=None, physical_connection_requirements=None, __props__=None);

func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)

public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Connection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Connection resource accepts the following input properties:

ConnectionProperties Dictionary<string, string>: A map of key-value pairs used as parameters for this connection.
CatalogId string: The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
ConnectionType string: The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.
Description string: Description of the connection.
MatchCriterias List<string>: A list of criteria that can be used in selecting this connection.
Name string: The name of the connection.
PhysicalConnectionRequirements ConnectionPhysicalConnectionRequirementsArgs: A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

ConnectionProperties map[string]string: A map of key-value pairs used as parameters for this connection.
CatalogId string: The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
ConnectionType string: The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.
Description string: Description of the connection.
MatchCriterias []string: A list of criteria that can be used in selecting this connection.
Name string: The name of the connection.
PhysicalConnectionRequirements ConnectionPhysicalConnectionRequirements: A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

connectionProperties {[key: string]: string}: A map of key-value pairs used as parameters for this connection.
catalogId string: The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
connectionType string: The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.
description string: Description of the connection.
matchCriterias string[]: A list of criteria that can be used in selecting this connection.
name string: The name of the connection.
physicalConnectionRequirements ConnectionPhysicalConnectionRequirements: A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

connection_properties Dict[str, str]: A map of key-value pairs used as parameters for this connection.
catalog_id str: The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
connection_type str: The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.
description str: Description of the connection.
match_criterias List[str]: A list of criteria that can be used in selecting this connection.
name str: The name of the connection.
physical_connection_requirements Dict[ConnectionPhysicalConnectionRequirements]: A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

Outputs

All input properties are implicitly available as output properties. Additionally, the Connection resource produces the following output properties:

Arn string: The ARN of the Glue Connection.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The ARN of the Glue Connection.
Id string: The provider-assigned unique ID for this managed resource.

arn string: The ARN of the Glue Connection.
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN of the Glue Connection.
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Connection Resource

Get an existing Connection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConnectionState, opts?: CustomResourceOptions): Connection

static get(resource_name, id, opts=None, arn=None, catalog_id=None, connection_properties=None, connection_type=None, description=None, match_criterias=None, name=None, physical_connection_requirements=None, __props__=None);

func GetConnection(ctx *Context, name string, id IDInput, state *ConnectionState, opts ...ResourceOption) (*Connection, error)

public static Connection Get(string name, Input<string> id, ConnectionState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The ARN of the Glue Connection.
CatalogId string: The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
ConnectionProperties Dictionary<string, string>: A map of key-value pairs used as parameters for this connection.
ConnectionType string: The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.
Description string: Description of the connection.
MatchCriterias List<string>: A list of criteria that can be used in selecting this connection.
Name string: The name of the connection.
PhysicalConnectionRequirements ConnectionPhysicalConnectionRequirementsArgs: A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

Arn string: The ARN of the Glue Connection.
CatalogId string: The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
ConnectionProperties map[string]string: A map of key-value pairs used as parameters for this connection.
ConnectionType string: The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.
Description string: Description of the connection.
MatchCriterias []string: A list of criteria that can be used in selecting this connection.
Name string: The name of the connection.
PhysicalConnectionRequirements ConnectionPhysicalConnectionRequirements: A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

arn string: The ARN of the Glue Connection.
catalogId string: The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
connectionProperties {[key: string]: string}: A map of key-value pairs used as parameters for this connection.
connectionType string: The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.
description string: Description of the connection.
matchCriterias string[]: A list of criteria that can be used in selecting this connection.
name string: The name of the connection.
physicalConnectionRequirements ConnectionPhysicalConnectionRequirements: A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

arn str: The ARN of the Glue Connection.
catalog_id str: The ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default.
connection_properties Dict[str, str]: A map of key-value pairs used as parameters for this connection.
connection_type str: The type of the connection. Supported are: JDBC, MONGODB, KAFKA. Defaults to JBDC.
description str: Description of the connection.
match_criterias List[str]: A list of criteria that can be used in selecting this connection.
name str: The name of the connection.
physical_connection_requirements Dict[ConnectionPhysicalConnectionRequirements]: A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.

Supporting Types

ConnectionPhysicalConnectionRequirements

See the input and output API doc for this type.

AvailabilityZone string: The availability zone of the connection. This field is redundant and implied by subnet_id, but is currently an api requirement.
SecurityGroupIdLists List<string>: The security group ID list used by the connection.
SubnetId string: The subnet ID used by the connection.

AvailabilityZone string: The availability zone of the connection. This field is redundant and implied by subnet_id, but is currently an api requirement.
SecurityGroupIdLists []string: The security group ID list used by the connection.
SubnetId string: The subnet ID used by the connection.

availabilityZone string: The availability zone of the connection. This field is redundant and implied by subnet_id, but is currently an api requirement.
securityGroupIdLists string[]: The security group ID list used by the connection.
subnetId string: The subnet ID used by the connection.

availability_zone str: The availability zone of the connection. This field is redundant and implied by subnet_id, but is currently an api requirement.
securityGroupIdLists List[str]: The security group ID list used by the connection.
subnet_id str: The subnet ID used by the connection.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud