Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. codestarconnections
  5. Connection

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.codestarconnections.Connection

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Schema for AWS::CodeStarConnections::Connection resource which can be used to connect external source providers with AWS CodePipeline

    Example Usage

    Example

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

return await Deployment.RunAsync(() => 
{
    var sampleConnection = new AwsNative.CodeStarConnections.Connection("sampleConnection", new()
    {
        ConnectionName = "MyConnection",
        ProviderType = "Bitbucket",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "Project",
                Value = "ProjectB",
            },
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codestarconnections.NewConnection(ctx, "sampleConnection", &codestarconnections.ConnectionArgs{
			ConnectionName: pulumi.String("MyConnection"),
			ProviderType:   pulumi.String("Bitbucket"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("Project"),
					Value: pulumi.String("ProjectB"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

sample_connection = aws_native.codestarconnections.Connection("sampleConnection",
    connection_name="MyConnection",
    provider_type="Bitbucket",
    tags=[{
        "key": "Project",
        "value": "ProjectB",
    }])

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const sampleConnection = new aws_native.codestarconnections.Connection("sampleConnection", {
    connectionName: "MyConnection",
    providerType: "Bitbucket",
    tags: [{
        key: "Project",
        value: "ProjectB",
    }],
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var sampleConnection = new AwsNative.CodeStarConnections.Connection("sampleConnection", new()
    {
        ConnectionName = "MyConnection",
        ProviderType = "Bitbucket",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "Project",
                Value = "ProjectB",
            },
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codestarconnections.NewConnection(ctx, "sampleConnection", &codestarconnections.ConnectionArgs{
			ConnectionName: pulumi.String("MyConnection"),
			ProviderType:   pulumi.String("Bitbucket"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("Project"),
					Value: pulumi.String("ProjectB"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

sample_connection = aws_native.codestarconnections.Connection("sampleConnection",
    connection_name="MyConnection",
    provider_type="Bitbucket",
    tags=[{
        "key": "Project",
        "value": "ProjectB",
    }])

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const sampleConnection = new aws_native.codestarconnections.Connection("sampleConnection", {
    connectionName: "MyConnection",
    providerType: "Bitbucket",
    tags: [{
        key: "Project",
        value: "ProjectB",
    }],
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var sampleConnection = new AwsNative.CodeStarConnections.Connection("sampleConnection", new()
    {
        ConnectionName = "MyConnection",
        ProviderType = "GitHubEnterpriseServer",
        HostArn = "arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "Project",
                Value = "ProjectB",
            },
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codestarconnections.NewConnection(ctx, "sampleConnection", &codestarconnections.ConnectionArgs{
			ConnectionName: pulumi.String("MyConnection"),
			ProviderType:   pulumi.String("GitHubEnterpriseServer"),
			HostArn:        pulumi.String("arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("Project"),
					Value: pulumi.String("ProjectB"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

sample_connection = aws_native.codestarconnections.Connection("sampleConnection",
    connection_name="MyConnection",
    provider_type="GitHubEnterpriseServer",
    host_arn="arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example",
    tags=[{
        "key": "Project",
        "value": "ProjectB",
    }])

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const sampleConnection = new aws_native.codestarconnections.Connection("sampleConnection", {
    connectionName: "MyConnection",
    providerType: "GitHubEnterpriseServer",
    hostArn: "arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example",
    tags: [{
        key: "Project",
        value: "ProjectB",
    }],
});

    Coming soon!

    Example

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

return await Deployment.RunAsync(() => 
{
    var sampleConnection = new AwsNative.CodeStarConnections.Connection("sampleConnection", new()
    {
        ConnectionName = "MyConnection",
        ProviderType = "GitHubEnterpriseServer",
        HostArn = "arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example",
        Tags = new[]
        {
            new AwsNative.Inputs.TagArgs
            {
                Key = "Project",
                Value = "ProjectB",
            },
        },
    });

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codestarconnections.NewConnection(ctx, "sampleConnection", &codestarconnections.ConnectionArgs{
			ConnectionName: pulumi.String("MyConnection"),
			ProviderType:   pulumi.String("GitHubEnterpriseServer"),
			HostArn:        pulumi.String("arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example"),
			Tags: aws.TagArray{
				&aws.TagArgs{
					Key:   pulumi.String("Project"),
					Value: pulumi.String("ProjectB"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

sample_connection = aws_native.codestarconnections.Connection("sampleConnection",
    connection_name="MyConnection",
    provider_type="GitHubEnterpriseServer",
    host_arn="arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example",
    tags=[{
        "key": "Project",
        "value": "ProjectB",
    }])

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const sampleConnection = new aws_native.codestarconnections.Connection("sampleConnection", {
    connectionName: "MyConnection",
    providerType: "GitHubEnterpriseServer",
    hostArn: "arn:aws:codestar-connections:us-west-2:123456789123:host/abc123-example",
    tags: [{
        key: "Project",
        value: "ProjectB",
    }],
});

    Coming soon!

    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,
               connection_name: Optional[str] = None,
               host_arn: Optional[str] = None,
               provider_type: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:codestarconnections: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.

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Connection resource accepts the following input properties:

    ConnectionName string
    The name of the connection. Connection names must be unique in an AWS user account.
    HostArn string
    The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
    ProviderType string
    The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Specifies the tags applied to a connection.
    ConnectionName string
    The name of the connection. Connection names must be unique in an AWS user account.
    HostArn string
    The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
    ProviderType string
    The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
    Tags TagArgs
    Specifies the tags applied to a connection.
    connectionName String
    The name of the connection. Connection names must be unique in an AWS user account.
    hostArn String
    The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
    providerType String
    The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
    tags List<Tag>
    Specifies the tags applied to a connection.
    connectionName string
    The name of the connection. Connection names must be unique in an AWS user account.
    hostArn string
    The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
    providerType string
    The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
    tags Tag[]
    Specifies the tags applied to a connection.
    connection_name str
    The name of the connection. Connection names must be unique in an AWS user account.
    host_arn str
    The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
    provider_type str
    The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
    tags Sequence[TagArgs]
    Specifies the tags applied to a connection.
    connectionName String
    The name of the connection. Connection names must be unique in an AWS user account.
    hostArn String
    The host arn configured to represent the infrastructure where your third-party provider is installed. You must specify either a ProviderType or a HostArn.
    providerType String
    The name of the external provider where your third-party code repository is configured. You must specify either a ProviderType or a HostArn.
    tags List<Property Map>
    Specifies the tags applied to a connection.

    Outputs

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

    ConnectionArn string
    The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
    ConnectionStatus string
    The current status of the connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
    ConnectionArn string
    The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
    ConnectionStatus string
    The current status of the connection.
    Id string
    The provider-assigned unique ID for this managed resource.
    OwnerAccountId string
    The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
    connectionArn String
    The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
    connectionStatus String
    The current status of the connection.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
    connectionArn string
    The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
    connectionStatus string
    The current status of the connection.
    id string
    The provider-assigned unique ID for this managed resource.
    ownerAccountId string
    The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
    connection_arn str
    The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
    connection_status str
    The current status of the connection.
    id str
    The provider-assigned unique ID for this managed resource.
    owner_account_id str
    The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.
    connectionArn String
    The Amazon Resource Name (ARN) of the connection. The ARN is used as the connection reference when the connection is shared between AWS services.
    connectionStatus String
    The current status of the connection.
    id String
    The provider-assigned unique ID for this managed resource.
    ownerAccountId String
    The name of the external provider where your third-party code repository is configured. For Bitbucket, this is the account ID of the owner of the Bitbucket repository.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native