Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. codestarconnections
  5. getConnection
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.codestarconnections.getConnection

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Provides details about CodeStar Connection.

Example Usage

By ARN

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

const example = aws.codestarconnections.getConnection({
    arn: exampleAwsCodestarconnectionsConnection.arn,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.codestarconnections.get_connection(arn=example_aws_codestarconnections_connection["arn"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codestarconnections.LookupConnection(ctx, &codestarconnections.LookupConnectionArgs{
			Arn: pulumi.StringRef(exampleAwsCodestarconnectionsConnection.Arn),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.CodeStarConnections.GetConnection.Invoke(new()
    {
        Arn = exampleAwsCodestarconnectionsConnection.Arn,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.codestarconnections.CodestarconnectionsFunctions;
import com.pulumi.aws.codestarconnections.inputs.GetConnectionArgs;
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 = CodestarconnectionsFunctions.getConnection(GetConnectionArgs.builder()
            .arn(exampleAwsCodestarconnectionsConnection.arn())
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:codestarconnections:getConnection
      arguments:
        arn: ${exampleAwsCodestarconnectionsConnection.arn}
Copy

By Name

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

const example = aws.codestarconnections.getConnection({
    name: exampleAwsCodestarconnectionsConnection.name,
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.codestarconnections.get_connection(name=example_aws_codestarconnections_connection["name"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codestarconnections.LookupConnection(ctx, &codestarconnections.LookupConnectionArgs{
			Name: pulumi.StringRef(exampleAwsCodestarconnectionsConnection.Name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.CodeStarConnections.GetConnection.Invoke(new()
    {
        Name = exampleAwsCodestarconnectionsConnection.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.codestarconnections.CodestarconnectionsFunctions;
import com.pulumi.aws.codestarconnections.inputs.GetConnectionArgs;
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 = CodestarconnectionsFunctions.getConnection(GetConnectionArgs.builder()
            .name(exampleAwsCodestarconnectionsConnection.name())
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:codestarconnections:getConnection
      arguments:
        name: ${exampleAwsCodestarconnectionsConnection.name}
Copy

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>
Copy
def get_connection(arn: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetConnectionResult
def get_connection_output(arn: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetConnectionResult]
Copy
func LookupConnection(ctx *Context, args *LookupConnectionArgs, opts ...InvokeOption) (*LookupConnectionResult, error)
func LookupConnectionOutput(ctx *Context, args *LookupConnectionOutputArgs, opts ...InvokeOption) LookupConnectionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
public static Output<GetConnectionResult> getConnection(GetConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:codestarconnections/getConnection:getConnection
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn string
CodeStar Connection ARN.
Name string

CodeStar Connection name.

NOTE: When both arn and name are specified, arn takes precedence.

Tags Dictionary<string, string>
Map of key-value resource tags to associate with the resource.
Arn string
CodeStar Connection ARN.
Name string

CodeStar Connection name.

NOTE: When both arn and name are specified, arn takes precedence.

Tags map[string]string
Map of key-value resource tags to associate with the resource.
arn String
CodeStar Connection ARN.
name String

CodeStar Connection name.

NOTE: When both arn and name are specified, arn takes precedence.

tags Map<String,String>
Map of key-value resource tags to associate with the resource.
arn string
CodeStar Connection ARN.
name string

CodeStar Connection name.

NOTE: When both arn and name are specified, arn takes precedence.

tags {[key: string]: string}
Map of key-value resource tags to associate with the resource.
arn str
CodeStar Connection ARN.
name str

CodeStar Connection name.

NOTE: When both arn and name are specified, arn takes precedence.

tags Mapping[str, str]
Map of key-value resource tags to associate with the resource.
arn String
CodeStar Connection ARN.
name String

CodeStar Connection name.

NOTE: When both arn and name are specified, arn takes precedence.

tags Map<String>
Map of key-value resource tags to associate with the resource.

getConnection Result

The following output properties are available:

Arn string
ConnectionStatus string
CodeStar Connection status. Possible values are PENDING, AVAILABLE and ERROR.
HostArn string
ARN of the host associated with the connection.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the CodeStar Connection. The name is unique in the calling AWS account.
ProviderType string
Name of the external provider where your third-party code repository is configured. Possible values are Bitbucket, GitHub and GitLab. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an aws.codestarconnections.Host resource and use host_arn instead.
Tags Dictionary<string, string>
Map of key-value resource tags to associate with the resource.
Arn string
ConnectionStatus string
CodeStar Connection status. Possible values are PENDING, AVAILABLE and ERROR.
HostArn string
ARN of the host associated with the connection.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Name of the CodeStar Connection. The name is unique in the calling AWS account.
ProviderType string
Name of the external provider where your third-party code repository is configured. Possible values are Bitbucket, GitHub and GitLab. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an aws.codestarconnections.Host resource and use host_arn instead.
Tags map[string]string
Map of key-value resource tags to associate with the resource.
arn String
connectionStatus String
CodeStar Connection status. Possible values are PENDING, AVAILABLE and ERROR.
hostArn String
ARN of the host associated with the connection.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the CodeStar Connection. The name is unique in the calling AWS account.
providerType String
Name of the external provider where your third-party code repository is configured. Possible values are Bitbucket, GitHub and GitLab. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an aws.codestarconnections.Host resource and use host_arn instead.
tags Map<String,String>
Map of key-value resource tags to associate with the resource.
arn string
connectionStatus string
CodeStar Connection status. Possible values are PENDING, AVAILABLE and ERROR.
hostArn string
ARN of the host associated with the connection.
id string
The provider-assigned unique ID for this managed resource.
name string
Name of the CodeStar Connection. The name is unique in the calling AWS account.
providerType string
Name of the external provider where your third-party code repository is configured. Possible values are Bitbucket, GitHub and GitLab. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an aws.codestarconnections.Host resource and use host_arn instead.
tags {[key: string]: string}
Map of key-value resource tags to associate with the resource.
arn str
connection_status str
CodeStar Connection status. Possible values are PENDING, AVAILABLE and ERROR.
host_arn str
ARN of the host associated with the connection.
id str
The provider-assigned unique ID for this managed resource.
name str
Name of the CodeStar Connection. The name is unique in the calling AWS account.
provider_type str
Name of the external provider where your third-party code repository is configured. Possible values are Bitbucket, GitHub and GitLab. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an aws.codestarconnections.Host resource and use host_arn instead.
tags Mapping[str, str]
Map of key-value resource tags to associate with the resource.
arn String
connectionStatus String
CodeStar Connection status. Possible values are PENDING, AVAILABLE and ERROR.
hostArn String
ARN of the host associated with the connection.
id String
The provider-assigned unique ID for this managed resource.
name String
Name of the CodeStar Connection. The name is unique in the calling AWS account.
providerType String
Name of the external provider where your third-party code repository is configured. Possible values are Bitbucket, GitHub and GitLab. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an aws.codestarconnections.Host resource and use host_arn instead.
tags Map<String>
Map of key-value resource tags to associate with the resource.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws