Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. glue
  5. Connection

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.glue.Connection

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Glue Connection resource.

    Example Usage

    Non-VPC Connection

    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",
    },
    name: "example",
});

    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",
    },
    name="example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/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"),
			},
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Glue.Connection("example", new()
    {
        ConnectionProperties = 
        {
            { "JDBC_CONNECTION_URL", "jdbc:mysql://example.com/exampledatabase" },
            { "PASSWORD", "examplepassword" },
            { "USERNAME", "exampleusername" },
        },
        Name = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.Connection;
import com.pulumi.aws.glue.ConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Connection("example", ConnectionArgs.builder()
            .connectionProperties(Map.ofEntries(
                Map.entry("JDBC_CONNECTION_URL", "jdbc:mysql://example.com/exampledatabase"),
                Map.entry("PASSWORD", "examplepassword"),
                Map.entry("USERNAME", "exampleusername")
            ))
            .name("example")
            .build());

    }
}

    resources:
  example:
    type: aws:glue:Connection
    properties:
      connectionProperties:
        JDBC_CONNECTION_URL: jdbc:mysql://example.com/exampledatabase
        PASSWORD: examplepassword
        USERNAME: exampleusername
      name: example

    Non-VPC Connection with secret manager reference

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

const example = aws.secretsmanager.getSecret({
    name: "example-secret",
});
const exampleConnection = new aws.glue.Connection("example", {
    connectionProperties: {
        JDBC_CONNECTION_URL: "jdbc:mysql://example.com/exampledatabase",
        SECRET_ID: example.then(example => example.name),
    },
    name: "example",
});

    import pulumi
import pulumi_aws as aws

example = aws.secretsmanager.get_secret(name="example-secret")
example_connection = aws.glue.Connection("example",
    connection_properties={
        "JDBC_CONNECTION_URL": "jdbc:mysql://example.com/exampledatabase",
        "SECRET_ID": example.name,
    },
    name="example")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/secretsmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := secretsmanager.LookupSecret(ctx, &secretsmanager.LookupSecretArgs{
			Name: pulumi.StringRef("example-secret"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = glue.NewConnection(ctx, "example", &glue.ConnectionArgs{
			ConnectionProperties: pulumi.StringMap{
				"JDBC_CONNECTION_URL": pulumi.String("jdbc:mysql://example.com/exampledatabase"),
				"SECRET_ID":           pulumi.String(example.Name),
			},
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.SecretsManager.GetSecret.Invoke(new()
    {
        Name = "example-secret",
    });

    var exampleConnection = new Aws.Glue.Connection("example", new()
    {
        ConnectionProperties = 
        {
            { "JDBC_CONNECTION_URL", "jdbc:mysql://example.com/exampledatabase" },
            { "SECRET_ID", example.Apply(getSecretResult => getSecretResult.Name) },
        },
        Name = "example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.secretsmanager.SecretsmanagerFunctions;
import com.pulumi.aws.secretsmanager.inputs.GetSecretArgs;
import com.pulumi.aws.glue.Connection;
import com.pulumi.aws.glue.ConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = SecretsmanagerFunctions.getSecret(GetSecretArgs.builder()
            .name("example-secret")
            .build());

        var exampleConnection = new Connection("exampleConnection", ConnectionArgs.builder()
            .connectionProperties(Map.ofEntries(
                Map.entry("JDBC_CONNECTION_URL", "jdbc:mysql://example.com/exampledatabase"),
                Map.entry("SECRET_ID", example.applyValue(getSecretResult -> getSecretResult.name()))
            ))
            .name("example")
            .build());

    }
}

    resources:
  exampleConnection:
    type: aws:glue:Connection
    name: example
    properties:
      connectionProperties:
        JDBC_CONNECTION_URL: jdbc:mysql://example.com/exampledatabase
        SECRET_ID: ${example.name}
      name: example
variables:
  example:
    fn::invoke:
      Function: aws:secretsmanager:getSecret
      Arguments:
        name: example-secret

    VPC Connection

    For more information, see the AWS Documentation.

    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://${exampleAwsRdsCluster.endpoint}/exampledatabase`,
        PASSWORD: "examplepassword",
        USERNAME: "exampleusername",
    },
    name: "example",
    physicalConnectionRequirements: {
        availabilityZone: exampleAwsSubnet.availabilityZone,
        securityGroupIdLists: [exampleAwsSecurityGroup.id],
        subnetId: exampleAwsSubnet.id,
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.glue.Connection("example",
    connection_properties={
        "JDBC_CONNECTION_URL": f"jdbc:mysql://{example_aws_rds_cluster['endpoint']}/exampledatabase",
        "PASSWORD": "examplepassword",
        "USERNAME": "exampleusername",
    },
    name="example",
    physical_connection_requirements={
        "availabilityZone": example_aws_subnet["availabilityZone"],
        "securityGroupIdLists": [example_aws_security_group["id"]],
        "subnetId": example_aws_subnet["id"],
    })

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
	"github.com/pulumi/pulumi/sdk/v3/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(fmt.Sprintf("jdbc:mysql://%v/exampledatabase", exampleAwsRdsCluster.Endpoint)),
				"PASSWORD":            pulumi.String("examplepassword"),
				"USERNAME":            pulumi.String("exampleusername"),
			},
			Name: pulumi.String("example"),
			PhysicalConnectionRequirements: &glue.ConnectionPhysicalConnectionRequirementsArgs{
				AvailabilityZone: pulumi.Any(exampleAwsSubnet.AvailabilityZone),
				SecurityGroupIdLists: pulumi.StringArray{
					exampleAwsSecurityGroup.Id,
				},
				SubnetId: pulumi.Any(exampleAwsSubnet.Id),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Glue.Connection("example", new()
    {
        ConnectionProperties = 
        {
            { "JDBC_CONNECTION_URL", $"jdbc:mysql://{exampleAwsRdsCluster.Endpoint}/exampledatabase" },
            { "PASSWORD", "examplepassword" },
            { "USERNAME", "exampleusername" },
        },
        Name = "example",
        PhysicalConnectionRequirements = new Aws.Glue.Inputs.ConnectionPhysicalConnectionRequirementsArgs
        {
            AvailabilityZone = exampleAwsSubnet.AvailabilityZone,
            SecurityGroupIdLists = new[]
            {
                exampleAwsSecurityGroup.Id,
            },
            SubnetId = exampleAwsSubnet.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.glue.Connection;
import com.pulumi.aws.glue.ConnectionArgs;
import com.pulumi.aws.glue.inputs.ConnectionPhysicalConnectionRequirementsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Connection("example", ConnectionArgs.builder()
            .connectionProperties(Map.ofEntries(
                Map.entry("JDBC_CONNECTION_URL", String.format("jdbc:mysql://%s/exampledatabase", exampleAwsRdsCluster.endpoint())),
                Map.entry("PASSWORD", "examplepassword"),
                Map.entry("USERNAME", "exampleusername")
            ))
            .name("example")
            .physicalConnectionRequirements(ConnectionPhysicalConnectionRequirementsArgs.builder()
                .availabilityZone(exampleAwsSubnet.availabilityZone())
                .securityGroupIdLists(exampleAwsSecurityGroup.id())
                .subnetId(exampleAwsSubnet.id())
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:glue:Connection
    properties:
      connectionProperties:
        JDBC_CONNECTION_URL: jdbc:mysql://${exampleAwsRdsCluster.endpoint}/exampledatabase
        PASSWORD: examplepassword
        USERNAME: exampleusername
      name: example
      physicalConnectionRequirements:
        availabilityZone: ${exampleAwsSubnet.availabilityZone}
        securityGroupIdLists:
          - ${exampleAwsSecurityGroup.id}
        subnetId: ${exampleAwsSubnet.id}

    Connection using a custom connector

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

// Define the custom connector using the connection_type of `CUSTOM` with the match_criteria of `template_connection`
// Example here being a snowflake jdbc connector with a secret having user and password as keys
const example = aws.secretsmanager.getSecret({
    name: "example-secret",
});
const exampleConnector = new aws.glue.Connection("example_connector", {
    connectionType: "CUSTOM",
    connectionProperties: {
        CONNECTOR_CLASS_NAME: "net.snowflake.client.jdbc.SnowflakeDriver",
        CONNECTION_TYPE: "Jdbc",
        CONNECTOR_URL: "s3://example/snowflake-jdbc.jar",
        JDBC_CONNECTION_URL: "[[\"default=jdbc:snowflake://example.com/?user=${user}&password=${password}\"],\",\"]",
    },
    name: "example_connector",
    matchCriterias: ["template-connection"],
});
// Reference the connector using match_criteria with the connector created above.
const exampleConnection = new aws.glue.Connection("example_connection", {
    connectionType: "CUSTOM",
    connectionProperties: {
        CONNECTOR_CLASS_NAME: "net.snowflake.client.jdbc.SnowflakeDriver",
        CONNECTION_TYPE: "Jdbc",
        CONNECTOR_URL: "s3://example/snowflake-jdbc.jar",
        JDBC_CONNECTION_URL: "jdbc:snowflake://example.com/?user=${user}&password=${password}",
        SECRET_ID: example.then(example => example.name),
    },
    name: "example",
    matchCriterias: [
        "Connection",
        exampleConnector.name,
    ],
});

    import pulumi
import pulumi_aws as aws

# Define the custom connector using the connection_type of `CUSTOM` with the match_criteria of `template_connection`
# Example here being a snowflake jdbc connector with a secret having user and password as keys
example = aws.secretsmanager.get_secret(name="example-secret")
example_connector = aws.glue.Connection("example_connector",
    connection_type="CUSTOM",
    connection_properties={
        "CONNECTOR_CLASS_NAME": "net.snowflake.client.jdbc.SnowflakeDriver",
        "CONNECTION_TYPE": "Jdbc",
        "CONNECTOR_URL": "s3://example/snowflake-jdbc.jar",
        "JDBC_CONNECTION_URL": "[[\"default=jdbc:snowflake://example.com/?user=${user}&password=${password}\"],\",\"]",
    },
    name="example_connector",
    match_criterias=["template-connection"])
# Reference the connector using match_criteria with the connector created above.
example_connection = aws.glue.Connection("example_connection",
    connection_type="CUSTOM",
    connection_properties={
        "CONNECTOR_CLASS_NAME": "net.snowflake.client.jdbc.SnowflakeDriver",
        "CONNECTION_TYPE": "Jdbc",
        "CONNECTOR_URL": "s3://example/snowflake-jdbc.jar",
        "JDBC_CONNECTION_URL": "jdbc:snowflake://example.com/?user=${user}&password=${password}",
        "SECRET_ID": example.name,
    },
    name="example",
    match_criterias=[
        "Connection",
        example_connector.name,
    ])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/glue"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/secretsmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Define the custom connector using the connection_type of `CUSTOM` with the match_criteria of `template_connection`
		// Example here being a snowflake jdbc connector with a secret having user and password as keys
		example, err := secretsmanager.LookupSecret(ctx, &secretsmanager.LookupSecretArgs{
			Name: pulumi.StringRef("example-secret"),
		}, nil)
		if err != nil {
			return err
		}
		exampleConnector, err := glue.NewConnection(ctx, "example_connector", &glue.ConnectionArgs{
			ConnectionType: pulumi.String("CUSTOM"),
			ConnectionProperties: pulumi.StringMap{
				"CONNECTOR_CLASS_NAME": pulumi.String("net.snowflake.client.jdbc.SnowflakeDriver"),
				"CONNECTION_TYPE":      pulumi.String("Jdbc"),
				"CONNECTOR_URL":        pulumi.String("s3://example/snowflake-jdbc.jar"),
				"JDBC_CONNECTION_URL":  pulumi.String("[[\"default=jdbc:snowflake://example.com/?user=${user}&password=${password}\"],\",\"]"),
			},
			Name: pulumi.String("example_connector"),
			MatchCriterias: pulumi.StringArray{
				pulumi.String("template-connection"),
			},
		})
		if err != nil {
			return err
		}
		// Reference the connector using match_criteria with the connector created above.
		_, err = glue.NewConnection(ctx, "example_connection", &glue.ConnectionArgs{
			ConnectionType: pulumi.String("CUSTOM"),
			ConnectionProperties: pulumi.StringMap{
				"CONNECTOR_CLASS_NAME": pulumi.String("net.snowflake.client.jdbc.SnowflakeDriver"),
				"CONNECTION_TYPE":      pulumi.String("Jdbc"),
				"CONNECTOR_URL":        pulumi.String("s3://example/snowflake-jdbc.jar"),
				"JDBC_CONNECTION_URL":  pulumi.String("jdbc:snowflake://example.com/?user=${user}&password=${password}"),
				"SECRET_ID":            pulumi.String(example.Name),
			},
			Name: pulumi.String("example"),
			MatchCriterias: pulumi.StringArray{
				pulumi.String("Connection"),
				exampleConnector.Name,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    // Define the custom connector using the connection_type of `CUSTOM` with the match_criteria of `template_connection`
    // Example here being a snowflake jdbc connector with a secret having user and password as keys
    var example = Aws.SecretsManager.GetSecret.Invoke(new()
    {
        Name = "example-secret",
    });

    var exampleConnector = new Aws.Glue.Connection("example_connector", new()
    {
        ConnectionType = "CUSTOM",
        ConnectionProperties = 
        {
            { "CONNECTOR_CLASS_NAME", "net.snowflake.client.jdbc.SnowflakeDriver" },
            { "CONNECTION_TYPE", "Jdbc" },
            { "CONNECTOR_URL", "s3://example/snowflake-jdbc.jar" },
            { "JDBC_CONNECTION_URL", "[[\"default=jdbc:snowflake://example.com/?user=${user}&password=${password}\"],\",\"]" },
        },
        Name = "example_connector",
        MatchCriterias = new[]
        {
            "template-connection",
        },
    });

    // Reference the connector using match_criteria with the connector created above.
    var exampleConnection = new Aws.Glue.Connection("example_connection", new()
    {
        ConnectionType = "CUSTOM",
        ConnectionProperties = 
        {
            { "CONNECTOR_CLASS_NAME", "net.snowflake.client.jdbc.SnowflakeDriver" },
            { "CONNECTION_TYPE", "Jdbc" },
            { "CONNECTOR_URL", "s3://example/snowflake-jdbc.jar" },
            { "JDBC_CONNECTION_URL", "jdbc:snowflake://example.com/?user=${user}&password=${password}" },
            { "SECRET_ID", example.Apply(getSecretResult => getSecretResult.Name) },
        },
        Name = "example",
        MatchCriterias = new[]
        {
            "Connection",
            exampleConnector.Name,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.secretsmanager.SecretsmanagerFunctions;
import com.pulumi.aws.secretsmanager.inputs.GetSecretArgs;
import com.pulumi.aws.glue.Connection;
import com.pulumi.aws.glue.ConnectionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Define the custom connector using the connection_type of `CUSTOM` with the match_criteria of `template_connection`
        // Example here being a snowflake jdbc connector with a secret having user and password as keys
        final var example = SecretsmanagerFunctions.getSecret(GetSecretArgs.builder()
            .name("example-secret")
            .build());

        var exampleConnector = new Connection("exampleConnector", ConnectionArgs.builder()
            .connectionType("CUSTOM")
            .connectionProperties(Map.ofEntries(
                Map.entry("CONNECTOR_CLASS_NAME", "net.snowflake.client.jdbc.SnowflakeDriver"),
                Map.entry("CONNECTION_TYPE", "Jdbc"),
                Map.entry("CONNECTOR_URL", "s3://example/snowflake-jdbc.jar"),
                Map.entry("JDBC_CONNECTION_URL", "[[\"default=jdbc:snowflake://example.com/?user=${user}&password=${password}\"],\",\"]")
            ))
            .name("example_connector")
            .matchCriterias("template-connection")
            .build());

        // Reference the connector using match_criteria with the connector created above.
        var exampleConnection = new Connection("exampleConnection", ConnectionArgs.builder()
            .connectionType("CUSTOM")
            .connectionProperties(Map.ofEntries(
                Map.entry("CONNECTOR_CLASS_NAME", "net.snowflake.client.jdbc.SnowflakeDriver"),
                Map.entry("CONNECTION_TYPE", "Jdbc"),
                Map.entry("CONNECTOR_URL", "s3://example/snowflake-jdbc.jar"),
                Map.entry("JDBC_CONNECTION_URL", "jdbc:snowflake://example.com/?user=${user}&password=${password}"),
                Map.entry("SECRET_ID", example.applyValue(getSecretResult -> getSecretResult.name()))
            ))
            .name("example")
            .matchCriterias(            
                "Connection",
                exampleConnector.name())
            .build());

    }
}

    resources:
  exampleConnector:
    type: aws:glue:Connection
    name: example_connector
    properties:
      connectionType: CUSTOM
      connectionProperties:
        CONNECTOR_CLASS_NAME: net.snowflake.client.jdbc.SnowflakeDriver
        CONNECTION_TYPE: Jdbc
        CONNECTOR_URL: s3://example/snowflake-jdbc.jar
        JDBC_CONNECTION_URL: '[["default=jdbc:snowflake://example.com/?user=${user}&password=${password}"],","]'
      name: example_connector
      matchCriterias:
        - template-connection
  # Reference the connector using match_criteria with the connector created above.
  exampleConnection:
    type: aws:glue:Connection
    name: example_connection
    properties:
      connectionType: CUSTOM
      connectionProperties:
        CONNECTOR_CLASS_NAME: net.snowflake.client.jdbc.SnowflakeDriver
        CONNECTION_TYPE: Jdbc
        CONNECTOR_URL: s3://example/snowflake-jdbc.jar
        JDBC_CONNECTION_URL: jdbc:snowflake://example.com/?user=${user}&password=${password}
        SECRET_ID: ${example.name}
      name: example
      matchCriterias:
        - Connection
        - ${exampleConnector.name}
variables:
  # Define the custom connector using the connection_type of `CUSTOM` with the match_criteria of `template_connection`
  # Example here being a snowflake jdbc connector with a secret having user and password as keys
  example:
    fn::invoke:
      Function: aws:secretsmanager:getSecret
      Arguments:
        name: example-secret

    Create Connection Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Connection(name: string, args?: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
def Connection(resource_name: str,
               args: Optional[ConnectionArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               catalog_id: Optional[str] = None,
               connection_properties: Optional[Mapping[str, str]] = None,
               connection_type: Optional[str] = None,
               description: Optional[str] = None,
               match_criterias: Optional[Sequence[str]] = None,
               name: Optional[str] = None,
               physical_connection_requirements: Optional[ConnectionPhysicalConnectionRequirementsArgs] = None,
               tags: Optional[Mapping[str, str]] = None)
    func NewConnection(ctx *Context, name string, args *ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs? args = null, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

    type: aws:glue:Connection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args ConnectionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleconnectionResourceResourceFromGlueconnection = new Aws.Glue.Connection("exampleconnectionResourceResourceFromGlueconnection", new()
{
    CatalogId = "string",
    ConnectionProperties = 
    {
        { "string", "string" },
    },
    ConnectionType = "string",
    Description = "string",
    MatchCriterias = new[]
    {
        "string",
    },
    Name = "string",
    PhysicalConnectionRequirements = new Aws.Glue.Inputs.ConnectionPhysicalConnectionRequirementsArgs
    {
        AvailabilityZone = "string",
        SecurityGroupIdLists = new[]
        {
            "string",
        },
        SubnetId = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := glue.NewConnection(ctx, "exampleconnectionResourceResourceFromGlueconnection", &glue.ConnectionArgs{
	CatalogId: pulumi.String("string"),
	ConnectionProperties: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ConnectionType: pulumi.String("string"),
	Description:    pulumi.String("string"),
	MatchCriterias: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	PhysicalConnectionRequirements: &glue.ConnectionPhysicalConnectionRequirementsArgs{
		AvailabilityZone: pulumi.String("string"),
		SecurityGroupIdLists: pulumi.StringArray{
			pulumi.String("string"),
		},
		SubnetId: pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleconnectionResourceResourceFromGlueconnection = new Connection("exampleconnectionResourceResourceFromGlueconnection", ConnectionArgs.builder()
    .catalogId("string")
    .connectionProperties(Map.of("string", "string"))
    .connectionType("string")
    .description("string")
    .matchCriterias("string")
    .name("string")
    .physicalConnectionRequirements(ConnectionPhysicalConnectionRequirementsArgs.builder()
        .availabilityZone("string")
        .securityGroupIdLists("string")
        .subnetId("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    exampleconnection_resource_resource_from_glueconnection = aws.glue.Connection("exampleconnectionResourceResourceFromGlueconnection",
    catalog_id="string",
    connection_properties={
        "string": "string",
    },
    connection_type="string",
    description="string",
    match_criterias=["string"],
    name="string",
    physical_connection_requirements={
        "availabilityZone": "string",
        "securityGroupIdLists": ["string"],
        "subnetId": "string",
    },
    tags={
        "string": "string",
    })

    const exampleconnectionResourceResourceFromGlueconnection = new aws.glue.Connection("exampleconnectionResourceResourceFromGlueconnection", {
    catalogId: "string",
    connectionProperties: {
        string: "string",
    },
    connectionType: "string",
    description: "string",
    matchCriterias: ["string"],
    name: "string",
    physicalConnectionRequirements: {
        availabilityZone: "string",
        securityGroupIdLists: ["string"],
        subnetId: "string",
    },
    tags: {
        string: "string",
    },
});

    type: aws:glue:Connection
properties:
    catalogId: string
    connectionProperties:
        string: string
    connectionType: string
    description: string
    matchCriterias:
        - string
    name: string
    physicalConnectionRequirements:
        availabilityZone: string
        securityGroupIdLists:
            - string
        subnetId: string
    tags:
        string: string

    Connection Resource Properties

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

    Inputs

    The Connection resource accepts the following input properties:

    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: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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 ConnectionPhysicalConnectionRequirements
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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 ConnectionPhysicalConnectionRequirementsArgs
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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 ConnectionPhysicalConnectionRequirements
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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 Mapping[str, str]
    A map of key-value pairs used as parameters for this connection.
    connection_type str
    The type of the connection. Supported are: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    description str
    Description of the connection.
    match_criterias Sequence[str]
    A list of criteria that can be used in selecting this connection.
    name str
    The name of the connection.
    physical_connection_requirements ConnectionPhysicalConnectionRequirementsArgs
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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>
    A map of key-value pairs used as parameters for this connection.
    connectionType String
    The type of the connection. Supported are: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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 Property Map
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the Glue Connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Glue Connection.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the Glue Connection.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the Glue Connection.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Glue Connection.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        catalog_id: Optional[str] = None,
        connection_properties: Optional[Mapping[str, str]] = None,
        connection_type: Optional[str] = None,
        description: Optional[str] = None,
        match_criterias: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        physical_connection_requirements: Optional[ConnectionPhysicalConnectionRequirementsArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Connection
    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)
    public static Connection get(String name, Output<String> id, ConnectionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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 ConnectionPhysicalConnectionRequirements
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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 ConnectionPhysicalConnectionRequirementsArgs
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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 ConnectionPhysicalConnectionRequirements
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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 Mapping[str, str]
    A map of key-value pairs used as parameters for this connection.
    connection_type str
    The type of the connection. Supported are: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    description str
    Description of the connection.
    match_criterias Sequence[str]
    A list of criteria that can be used in selecting this connection.
    name str
    The name of the connection.
    physical_connection_requirements ConnectionPhysicalConnectionRequirementsArgs
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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>
    A map of key-value pairs used as parameters for this connection.
    connectionType String
    The type of the connection. Supported are: CUSTOM, JDBC, KAFKA, MARKETPLACE, MONGODB, and NETWORK. Defaults to JDBC.
    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 Property Map
    A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ConnectionPhysicalConnectionRequirements, ConnectionPhysicalConnectionRequirementsArgs

    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 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.
    availability_zone str
    The availability zone of the connection. This field is redundant and implied by subnet_id, but is currently an api requirement.
    security_group_id_lists Sequence[str]
    The security group ID list used by the connection.
    subnet_id str
    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 List<String>
    The security group ID list used by the connection.
    subnetId String
    The subnet ID used by the connection.

    Import

    Using pulumi import, import Glue Connections using the CATALOG-ID (AWS account ID if not custom) and NAME. For example:

    $ pulumi import aws:glue/connection:Connection MyConnection 123456789012:MyConnection

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws