Try AWS Native preview for resources not in the classic version.
aws.glue.Connection
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides a Glue Connection resource.
Example Usage
Non-VPC Connection
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" },
},
});
});
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"),
},
})
if err != nil {
return err
}
return nil
})
}
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")
))
.build());
}
}
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",
}});
resources:
example:
type: aws:glue:Connection
properties:
connectionProperties:
JDBC_CONNECTION_URL: jdbc:mysql://example.com/exampledatabase
PASSWORD: examplepassword
USERNAME: exampleusername
VPC Connection
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://{aws_rds_cluster.Example.Endpoint}/exampledatabase" },
{ "PASSWORD", "examplepassword" },
{ "USERNAME", "exampleusername" },
},
PhysicalConnectionRequirements = new Aws.Glue.Inputs.ConnectionPhysicalConnectionRequirementsArgs
{
AvailabilityZone = aws_subnet.Example.Availability_zone,
SecurityGroupIdLists = new[]
{
aws_security_group.Example.Id,
},
SubnetId = aws_subnet.Example.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", aws_rds_cluster.Example.Endpoint)),
"PASSWORD": pulumi.String("examplepassword"),
"USERNAME": pulumi.String("exampleusername"),
},
PhysicalConnectionRequirements: &glue.ConnectionPhysicalConnectionRequirementsArgs{
AvailabilityZone: pulumi.Any(aws_subnet.Example.Availability_zone),
SecurityGroupIdLists: pulumi.StringArray{
aws_security_group.Example.Id,
},
SubnetId: pulumi.Any(aws_subnet.Example.Id),
},
})
if err != nil {
return err
}
return nil
})
}
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", aws_rds_cluster.example().endpoint())),
Map.entry("PASSWORD", "examplepassword"),
Map.entry("USERNAME", "exampleusername")
))
.physicalConnectionRequirements(ConnectionPhysicalConnectionRequirementsArgs.builder()
.availabilityZone(aws_subnet.example().availability_zone())
.securityGroupIdLists(aws_security_group.example().id())
.subnetId(aws_subnet.example().id())
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.glue.Connection("example",
connection_properties={
"JDBC_CONNECTION_URL": f"jdbc:mysql://{aws_rds_cluster['example']['endpoint']}/exampledatabase",
"PASSWORD": "examplepassword",
"USERNAME": "exampleusername",
},
physical_connection_requirements=aws.glue.ConnectionPhysicalConnectionRequirementsArgs(
availability_zone=aws_subnet["example"]["availability_zone"],
security_group_id_lists=[aws_security_group["example"]["id"]],
subnet_id=aws_subnet["example"]["id"],
))
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://${aws_rds_cluster.example.endpoint}/exampledatabase`,
PASSWORD: "examplepassword",
USERNAME: "exampleusername",
},
physicalConnectionRequirements: {
availabilityZone: aws_subnet.example.availability_zone,
securityGroupIdLists: [aws_security_group.example.id],
subnetId: aws_subnet.example.id,
},
});
resources:
example:
type: aws:glue:Connection
properties:
connectionProperties:
JDBC_CONNECTION_URL: jdbc:mysql://${aws_rds_cluster.example.endpoint}/exampledatabase
PASSWORD: examplepassword
USERNAME: exampleusername
physicalConnectionRequirements:
availabilityZone: ${aws_subnet.example.availability_zone}
securityGroupIdLists:
- ${aws_security_group.example.id}
subnetId: ${aws_subnet.example.id}
Create Connection Resource
new Connection(name: string, args?: ConnectionArgs, opts?: CustomResourceOptions);
@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)
@overload
def Connection(resource_name: str,
args: Optional[ConnectionArgs] = None,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Catalog
Id 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.
- Connection
Properties Dictionary<string, string> A map of key-value pairs used as parameters for this connection.
- Connection
Type string The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- Description string
Description of the connection.
- Match
Criterias List<string> A list of criteria that can be used in selecting this connection.
- Name string
The name of the connection.
- Physical
Connection ConnectionRequirements Physical Connection Requirements A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.
- Catalog
Id 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.
- Connection
Properties map[string]string A map of key-value pairs used as parameters for this connection.
- Connection
Type string The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- Description string
Description of the connection.
- Match
Criterias []string A list of criteria that can be used in selecting this connection.
- Name string
The name of the connection.
- Physical
Connection ConnectionRequirements Physical Connection Requirements Args A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.
- catalog
Id 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.
- connection
Properties Map<String,String> A map of key-value pairs used as parameters for this connection.
- connection
Type String The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- description String
Description of the connection.
- match
Criterias List<String> A list of criteria that can be used in selecting this connection.
- name String
The name of the connection.
- physical
Connection ConnectionRequirements Physical Connection Requirements A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.
- catalog
Id 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.
- connection
Properties {[key: string]: string} A map of key-value pairs used as parameters for this connection.
- connection
Type string The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- description string
Description of the connection.
- match
Criterias string[] A list of criteria that can be used in selecting this connection.
- name string
The name of the connection.
- physical
Connection ConnectionRequirements Physical Connection Requirements A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- {[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
, andNETWORK
. Defaults toJBDC
.- 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_ Connectionrequirements Physical Connection Requirements Args A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.
- catalog
Id 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.
- connection
Properties Map<String> A map of key-value pairs used as parameters for this connection.
- connection
Type String The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- description String
Description of the connection.
- match
Criterias List<String> A list of criteria that can be used in selecting this connection.
- name String
The name of the connection.
- physical
Connection Property MapRequirements A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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:
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.
- Arn string
The ARN of the Glue Connection.
- Catalog
Id 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.
- Connection
Properties Dictionary<string, string> A map of key-value pairs used as parameters for this connection.
- Connection
Type string The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- Description string
Description of the connection.
- Match
Criterias List<string> A list of criteria that can be used in selecting this connection.
- Name string
The name of the connection.
- Physical
Connection ConnectionRequirements Physical Connection Requirements A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- Arn string
The ARN of the Glue Connection.
- Catalog
Id 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.
- Connection
Properties map[string]string A map of key-value pairs used as parameters for this connection.
- Connection
Type string The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- Description string
Description of the connection.
- Match
Criterias []string A list of criteria that can be used in selecting this connection.
- Name string
The name of the connection.
- Physical
Connection ConnectionRequirements Physical Connection Requirements Args A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
The ARN of the Glue Connection.
- catalog
Id 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.
- connection
Properties Map<String,String> A map of key-value pairs used as parameters for this connection.
- connection
Type String The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- description String
Description of the connection.
- match
Criterias List<String> A list of criteria that can be used in selecting this connection.
- name String
The name of the connection.
- physical
Connection ConnectionRequirements Physical Connection Requirements A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn string
The ARN of the Glue Connection.
- catalog
Id 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.
- connection
Properties {[key: string]: string} A map of key-value pairs used as parameters for this connection.
- connection
Type string The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- description string
Description of the connection.
- match
Criterias string[] A list of criteria that can be used in selecting this connection.
- name string
The name of the connection.
- physical
Connection ConnectionRequirements Physical Connection Requirements A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.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
, andNETWORK
. Defaults toJBDC
.- 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_ Connectionrequirements Physical Connection Requirements Args A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
The ARN of the Glue Connection.
- catalog
Id 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.
- connection
Properties Map<String> A map of key-value pairs used as parameters for this connection.
- connection
Type String The type of the connection. Supported are:
CUSTOM
,JDBC
,KAFKA
,MARKETPLACE
,MONGODB
, andNETWORK
. Defaults toJBDC
.- description String
Description of the connection.
- match
Criterias List<String> A list of criteria that can be used in selecting this connection.
- name String
The name of the connection.
- physical
Connection Property MapRequirements A map of physical connection requirements, such as VPC and SecurityGroup. Defined below.
- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
Supporting Types
ConnectionPhysicalConnectionRequirements, ConnectionPhysicalConnectionRequirementsArgs
- Availability
Zone string The availability zone of the connection. This field is redundant and implied by
subnet_id
, but is currently an api requirement.- Security
Group List<string>Id Lists The security group ID list used by the connection.
- Subnet
Id string The subnet ID used by the connection.
- Availability
Zone string The availability zone of the connection. This field is redundant and implied by
subnet_id
, but is currently an api requirement.- Security
Group []stringId Lists The security group ID list used by the connection.
- Subnet
Id string The subnet ID used by the connection.
- availability
Zone String The availability zone of the connection. This field is redundant and implied by
subnet_id
, but is currently an api requirement.- security
Group List<String>Id Lists The security group ID list used by the connection.
- subnet
Id String The subnet ID used by the connection.
- availability
Zone string The availability zone of the connection. This field is redundant and implied by
subnet_id
, but is currently an api requirement.- security
Group string[]Id Lists The security group ID list used by the connection.
- subnet
Id 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_ Sequence[str]id_ lists The security group ID list used by the connection.
- subnet_
id str The subnet ID used by the connection.
- availability
Zone String The availability zone of the connection. This field is redundant and implied by
subnet_id
, but is currently an api requirement.- security
Group List<String>Id Lists The security group ID list used by the connection.
- subnet
Id 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
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.