1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. glue
  6. getConnection
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi
aws logo
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi

    Provides details about an AWS Glue Connection.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.glue.getConnection({
        id: "123456789123:connection",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.glue.get_connection(id="123456789123:connection")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/glue"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := glue.LookupConnection(ctx, &glue.LookupConnectionArgs{
    			Id: "123456789123:connection",
    		}, nil)
    		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.Glue.GetConnection.Invoke(new()
        {
            Id = "123456789123:connection",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.glue.GlueFunctions;
    import com.pulumi.aws.glue.inputs.GetConnectionArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 = GlueFunctions.getConnection(GetConnectionArgs.builder()
                .id("123456789123:connection")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: aws:glue:getConnection
          arguments:
            id: 123456789123:connection
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    data "aws_glue_getconnection" "example" {
      id = "123456789123:connection"
    }
    

    Using getConnection

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getConnection(args: GetConnectionArgs, opts?: InvokeOptions): Promise<GetConnectionResult>
    function getConnectionOutput(args: GetConnectionOutputArgs, opts?: InvokeOptions): Output<GetConnectionResult>
    def get_connection(id: Optional[str] = None,
                       region: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetConnectionResult
    def get_connection_output(id: pulumi.Input[Optional[str]] = None,
                       region: pulumi.Input[Optional[str]] = None,
                       tags: pulumi.Input[Optional[Mapping[str, pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
    func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
    func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput

    > Note: This function is named LookupConnection in the Go SDK.

    public static class GetConnection 
    {
        public static Task<GetConnectionResult> InvokeAsync(GetConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetConnectionResult> Invoke(GetConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
    public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws:glue/getConnection:getConnection
      arguments:
        # arguments dictionary
    data "aws_glue_getconnection" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string

    Concatenation of the catalog ID and connection name. For example, if your account ID is 123456789123 and the connection name is conn then the ID is 123456789123:conn.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Tags assigned to the resource.
    Id string

    Concatenation of the catalog ID and connection name. For example, if your account ID is 123456789123 and the connection name is conn then the ID is 123456789123:conn.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Tags assigned to the resource.
    id string

    Concatenation of the catalog ID and connection name. For example, if your account ID is 123456789123 and the connection name is conn then the ID is 123456789123:conn.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Tags assigned to the resource.
    id String

    Concatenation of the catalog ID and connection name. For example, if your account ID is 123456789123 and the connection name is conn then the ID is 123456789123:conn.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Tags assigned to the resource.
    id string

    Concatenation of the catalog ID and connection name. For example, if your account ID is 123456789123 and the connection name is conn then the ID is 123456789123:conn.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Tags assigned to the resource.
    id str

    Concatenation of the catalog ID and connection name. For example, if your account ID is 123456789123 and the connection name is conn then the ID is 123456789123:conn.

    The following arguments are optional:

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Tags assigned to the resource.
    id String

    Concatenation of the catalog ID and connection name. For example, if your account ID is 123456789123 and the connection name is conn then the ID is 123456789123:conn.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Tags assigned to the resource.

    getConnection Result

    The following output properties are available:

    Arn string
    ARN of the Glue Connection.
    AthenaProperties Dictionary<string, string>
    Map of connection properties specific to the Athena compute environment.
    AuthenticationConfigurations List<GetConnectionAuthenticationConfiguration>
    Configuration block for authentication options.
    CatalogId string
    Catalog ID of the Glue Connection.
    ConnectionProperties Dictionary<string, string>
    Map of connection properties.
    ConnectionType string
    Type of Glue Connection.
    Description string
    Description of the connection.
    Id string
    MatchCriterias List<string>
    List of criteria that can be used in selecting this connection.
    Name string
    Name of the Glue Connection.
    PhysicalConnectionRequirements List<GetConnectionPhysicalConnectionRequirement>
    Map of physical connection requirements, such as VPC and SecurityGroup.
    Region string
    Tags Dictionary<string, string>
    Tags assigned to the resource.
    Arn string
    ARN of the Glue Connection.
    AthenaProperties map[string]string
    Map of connection properties specific to the Athena compute environment.
    AuthenticationConfigurations []GetConnectionAuthenticationConfiguration
    Configuration block for authentication options.
    CatalogId string
    Catalog ID of the Glue Connection.
    ConnectionProperties map[string]string
    Map of connection properties.
    ConnectionType string
    Type of Glue Connection.
    Description string
    Description of the connection.
    Id string
    MatchCriterias []string
    List of criteria that can be used in selecting this connection.
    Name string
    Name of the Glue Connection.
    PhysicalConnectionRequirements []GetConnectionPhysicalConnectionRequirement
    Map of physical connection requirements, such as VPC and SecurityGroup.
    Region string
    Tags map[string]string
    Tags assigned to the resource.
    arn string
    ARN of the Glue Connection.
    athena_properties map(string)
    Map of connection properties specific to the Athena compute environment.
    authentication_configurations list(object)
    Configuration block for authentication options.
    catalog_id string
    Catalog ID of the Glue Connection.
    connection_properties map(string)
    Map of connection properties.
    connection_type string
    Type of Glue Connection.
    description string
    Description of the connection.
    id string
    match_criterias list(string)
    List of criteria that can be used in selecting this connection.
    name string
    Name of the Glue Connection.
    physical_connection_requirements list(object)
    Map of physical connection requirements, such as VPC and SecurityGroup.
    region string
    tags map(string)
    Tags assigned to the resource.
    arn String
    ARN of the Glue Connection.
    athenaProperties Map<String,String>
    Map of connection properties specific to the Athena compute environment.
    authenticationConfigurations List<GetConnectionAuthenticationConfiguration>
    Configuration block for authentication options.
    catalogId String
    Catalog ID of the Glue Connection.
    connectionProperties Map<String,String>
    Map of connection properties.
    connectionType String
    Type of Glue Connection.
    description String
    Description of the connection.
    id String
    matchCriterias List<String>
    List of criteria that can be used in selecting this connection.
    name String
    Name of the Glue Connection.
    physicalConnectionRequirements List<GetConnectionPhysicalConnectionRequirement>
    Map of physical connection requirements, such as VPC and SecurityGroup.
    region String
    tags Map<String,String>
    Tags assigned to the resource.
    arn string
    ARN of the Glue Connection.
    athenaProperties {[key: string]: string}
    Map of connection properties specific to the Athena compute environment.
    authenticationConfigurations GetConnectionAuthenticationConfiguration[]
    Configuration block for authentication options.
    catalogId string
    Catalog ID of the Glue Connection.
    connectionProperties {[key: string]: string}
    Map of connection properties.
    connectionType string
    Type of Glue Connection.
    description string
    Description of the connection.
    id string
    matchCriterias string[]
    List of criteria that can be used in selecting this connection.
    name string
    Name of the Glue Connection.
    physicalConnectionRequirements GetConnectionPhysicalConnectionRequirement[]
    Map of physical connection requirements, such as VPC and SecurityGroup.
    region string
    tags {[key: string]: string}
    Tags assigned to the resource.
    arn str
    ARN of the Glue Connection.
    athena_properties Mapping[str, str]
    Map of connection properties specific to the Athena compute environment.
    authentication_configurations Sequence[GetConnectionAuthenticationConfiguration]
    Configuration block for authentication options.
    catalog_id str
    Catalog ID of the Glue Connection.
    connection_properties Mapping[str, str]
    Map of connection properties.
    connection_type str
    Type of Glue Connection.
    description str
    Description of the connection.
    id str
    match_criterias Sequence[str]
    List of criteria that can be used in selecting this connection.
    name str
    Name of the Glue Connection.
    physical_connection_requirements Sequence[GetConnectionPhysicalConnectionRequirement]
    Map of physical connection requirements, such as VPC and SecurityGroup.
    region str
    tags Mapping[str, str]
    Tags assigned to the resource.
    arn String
    ARN of the Glue Connection.
    athenaProperties Map<String>
    Map of connection properties specific to the Athena compute environment.
    authenticationConfigurations List<Property Map>
    Configuration block for authentication options.
    catalogId String
    Catalog ID of the Glue Connection.
    connectionProperties Map<String>
    Map of connection properties.
    connectionType String
    Type of Glue Connection.
    description String
    Description of the connection.
    id String
    matchCriterias List<String>
    List of criteria that can be used in selecting this connection.
    name String
    Name of the Glue Connection.
    physicalConnectionRequirements List<Property Map>
    Map of physical connection requirements, such as VPC and SecurityGroup.
    region String
    tags Map<String>
    Tags assigned to the resource.

    Supporting Types

    GetConnectionAuthenticationConfiguration

    GetConnectionAuthenticationConfigurationBasicAuthenticationCredential

    Password string
    Username string
    Password string
    Username string
    password string
    username string
    password String
    username String
    password string
    username string
    password String
    username String

    GetConnectionAuthenticationConfigurationOauth2Property

    GetConnectionAuthenticationConfigurationOauth2PropertyAuthorizationCodeProperty

    GetConnectionAuthenticationConfigurationOauth2PropertyOauth2ClientApplication

    GetConnectionAuthenticationConfigurationOauth2PropertyOauth2Credential

    GetConnectionPhysicalConnectionRequirement

    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
    Viewing docs for AWS v7.32.0
    published on Friday, May 29, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial