AWS Classic v5.41.0, May 15 23
AWS Classic v5.41.0, May 15 23
aws.apprunner.Connection
Explore with Pulumi AI
Manages an App Runner Connection.
NOTE: After creation, you must complete the authentication handshake using the App Runner console.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.AppRunner.Connection("example", new()
{
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 com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apprunner.Connection;
import com.pulumi.aws.apprunner.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()
.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 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:
- Connection
Name string Name of the connection.
- Provider
Type string Source repository provider. Valid values:
GITHUB
.- 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.
- Connection
Name string Name of the connection.
- Provider
Type string Source repository provider. Valid values:
GITHUB
.- 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.
- connection
Name String Name of the connection.
- provider
Type String Source repository provider. Valid values:
GITHUB
.- 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.
- connection
Name string Name of the connection.
- provider
Type string Source repository provider. Valid values:
GITHUB
.- {[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 Source repository provider. Valid values:
GITHUB
.- 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.
- connection
Name String Name of the connection.
- provider
Type String Source repository provider. Valid values:
GITHUB
.- 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
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- Dictionary<string, string>
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
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- map[string]string
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
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- Map<String,String>
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
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- {[key: string]: string}
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
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- Mapping[str, str]
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
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- Map<String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
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,
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.
- Arn string
ARN of the connection.
- Connection
Name string Name of the connection.
- Provider
Type string Source repository provider. Valid values:
GITHUB
.- Status string
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- 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>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
ARN of the connection.
- Connection
Name string Name of the connection.
- Provider
Type string Source repository provider. Valid values:
GITHUB
.- Status string
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- 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
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
ARN of the connection.
- connection
Name String Name of the connection.
- provider
Type String Source repository provider. Valid values:
GITHUB
.- status String
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- 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>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
ARN of the connection.
- connection
Name string Name of the connection.
- provider
Type string Source repository provider. Valid values:
GITHUB
.- status string
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- {[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}
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 Source repository provider. Valid values:
GITHUB
.- status str
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- 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]
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
ARN of the connection.
- connection
Name String Name of the connection.
- provider
Type String Source repository provider. Valid values:
GITHUB
.- status String
Current state of the App Runner connection. When the state is
AVAILABLE
, you can use the connection to create anaws.apprunner.Service
resource.- 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>
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
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.