AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

Connection

Manages an App Runner Connection.

NOTE: After creation, you must complete the authentication handshake using the App Runner console.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.AppRunner.Connection("example", new Aws.AppRunner.ConnectionArgs
        {
            ConnectionName = "example",
            ProviderType = "GITHUB",
            Tags = 
            {
                { "Name", "example-apprunner-connection" },
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/apprunner"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apprunner.NewConnection(ctx, "example", &apprunner.ConnectionArgs{
			ConnectionName: pulumi.String("example"),
			ProviderType:   pulumi.String("GITHUB"),
			Tags: pulumi.StringMap{
				"Name": pulumi.String("example-apprunner-connection"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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()        
            .connectionName("example")
            .providerType("GITHUB")
            .tags(Map.of("Name", "example-apprunner-connection"))
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.apprunner.Connection("example",
    connection_name="example",
    provider_type="GITHUB",
    tags={
        "Name": "example-apprunner-connection",
    })
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.apprunner.Connection("example", {
    connectionName: "example",
    providerType: "GITHUB",
    tags: {
        Name: "example-apprunner-connection",
    },
});
resources:
  example:
    type: aws:apprunner:Connection
    properties:
      connectionName: example
      providerType: GITHUB
      tags:
        Name: example-apprunner-connection

Create a Connection Resource

new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               connection_name: Optional[str] = None,
               provider_type: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None)
@overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)
func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)
type: aws:apprunner: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:

ConnectionName string

Name of the connection.

ProviderType string

The source repository provider. Valid values: GITHUB.

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.

ConnectionName string

Name of the connection.

ProviderType string

The source repository provider. Valid values: GITHUB.

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.

connectionName String

Name of the connection.

providerType String

The source repository provider. Valid values: GITHUB.

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.

connectionName string

Name of the connection.

providerType string

The source repository provider. Valid values: GITHUB.

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.

connection_name str

Name of the connection.

provider_type str

The source repository provider. Valid values: GITHUB.

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.

connectionName String

Name of the connection.

providerType String

The source repository provider. Valid values: GITHUB.

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

ARN of the connection.

Id string

The provider-assigned unique ID for this managed resource.

Status string

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string

ARN of the connection.

Id string

The provider-assigned unique ID for this managed resource.

Status string

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the connection.

id String

The provider-assigned unique ID for this managed resource.

status String

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string

ARN of the connection.

id string

The provider-assigned unique ID for this managed resource.

status string

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str

ARN of the connection.

id str

The provider-assigned unique ID for this managed resource.

status str

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String

ARN of the connection.

id String

The provider-assigned unique ID for this managed resource.

status String

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up an 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,
        connection_name: Optional[str] = None,
        provider_type: Optional[str] = None,
        status: Optional[str] = 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

ARN of the connection.

ConnectionName string

Name of the connection.

ProviderType string

The source repository provider. Valid values: GITHUB.

Status string

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

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.

Arn string

ARN of the connection.

ConnectionName string

Name of the connection.

ProviderType string

The source repository provider. Valid values: GITHUB.

Status string

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

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.

arn String

ARN of the connection.

connectionName String

Name of the connection.

providerType String

The source repository provider. Valid values: GITHUB.

status String

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

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.

arn string

ARN of the connection.

connectionName string

Name of the connection.

providerType string

The source repository provider. Valid values: GITHUB.

status string

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

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.

arn str

ARN of the connection.

connection_name str

Name of the connection.

provider_type str

The source repository provider. Valid values: GITHUB.

status str

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

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.

arn String

ARN of the connection.

connectionName String

Name of the connection.

providerType String

The source repository provider. Valid values: GITHUB.

status String

The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an aws.apprunner.Service resource.

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.

Import

App Runner Connections can be imported by using the connection_name, e.g.,

 $ pulumi import aws:apprunner/connection:Connection example example

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.