aws logo
AWS Classic v5.29.1, Feb 4 23

aws.apprunner.VpcConnector

Manages an App Runner VPC Connector.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var connector = new Aws.AppRunner.VpcConnector("connector", new()
    {
        SecurityGroups = new[]
        {
            "sg1",
            "sg2",
        },
        Subnets = new[]
        {
            "subnet1",
            "subnet2",
        },
        VpcConnectorName = "name",
    });

});
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.NewVpcConnector(ctx, "connector", &apprunner.VpcConnectorArgs{
			SecurityGroups: pulumi.StringArray{
				pulumi.String("sg1"),
				pulumi.String("sg2"),
			},
			Subnets: pulumi.StringArray{
				pulumi.String("subnet1"),
				pulumi.String("subnet2"),
			},
			VpcConnectorName: pulumi.String("name"),
		})
		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.VpcConnector;
import com.pulumi.aws.apprunner.VpcConnectorArgs;
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 connector = new VpcConnector("connector", VpcConnectorArgs.builder()        
            .securityGroups(            
                "sg1",
                "sg2")
            .subnets(            
                "subnet1",
                "subnet2")
            .vpcConnectorName("name")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

connector = aws.apprunner.VpcConnector("connector",
    security_groups=[
        "sg1",
        "sg2",
    ],
    subnets=[
        "subnet1",
        "subnet2",
    ],
    vpc_connector_name="name")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const connector = new aws.apprunner.VpcConnector("connector", {
    securityGroups: [
        "sg1",
        "sg2",
    ],
    subnets: [
        "subnet1",
        "subnet2",
    ],
    vpcConnectorName: "name",
});
resources:
  connector:
    type: aws:apprunner:VpcConnector
    properties:
      securityGroups:
        - sg1
        - sg2
      subnets:
        - subnet1
        - subnet2
      vpcConnectorName: name

Create VpcConnector Resource

new VpcConnector(name: string, args: VpcConnectorArgs, opts?: CustomResourceOptions);
@overload
def VpcConnector(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 security_groups: Optional[Sequence[str]] = None,
                 subnets: Optional[Sequence[str]] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 vpc_connector_name: Optional[str] = None)
@overload
def VpcConnector(resource_name: str,
                 args: VpcConnectorArgs,
                 opts: Optional[ResourceOptions] = None)
func NewVpcConnector(ctx *Context, name string, args VpcConnectorArgs, opts ...ResourceOption) (*VpcConnector, error)
public VpcConnector(string name, VpcConnectorArgs args, CustomResourceOptions? opts = null)
public VpcConnector(String name, VpcConnectorArgs args)
public VpcConnector(String name, VpcConnectorArgs args, CustomResourceOptions options)
type: aws:apprunner:VpcConnector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args VpcConnectorArgs
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 VpcConnectorArgs
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 VpcConnectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args VpcConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args VpcConnectorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

VpcConnector 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 VpcConnector resource accepts the following input properties:

SecurityGroups List<string>

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

Subnets List<string>

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

VpcConnectorName string

Name for the VPC connector.

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.

SecurityGroups []string

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

Subnets []string

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

VpcConnectorName string

Name for the VPC connector.

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.

securityGroups List<String>

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

subnets List<String>

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

vpcConnectorName String

Name for the VPC connector.

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.

securityGroups string[]

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

subnets string[]

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

vpcConnectorName string

Name for the VPC connector.

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.

security_groups Sequence[str]

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

subnets Sequence[str]

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

vpc_connector_name str

Name for the VPC connector.

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.

securityGroups List<String>

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

subnets List<String>

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

vpcConnectorName String

Name for the VPC connector.

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 VpcConnector resource produces the following output properties:

Arn string

ARN of VPC connector.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

TagsAll Dictionary<string, string>

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

VpcConnectorRevision int

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

Arn string

ARN of VPC connector.

Id string

The provider-assigned unique ID for this managed resource.

Status string

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

TagsAll map[string]string

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

VpcConnectorRevision int

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

arn String

ARN of VPC connector.

id String

The provider-assigned unique ID for this managed resource.

status String

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

tagsAll Map<String,String>

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

vpcConnectorRevision Integer

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

arn string

ARN of VPC connector.

id string

The provider-assigned unique ID for this managed resource.

status string

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

tagsAll {[key: string]: string}

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

vpcConnectorRevision number

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

arn str

ARN of VPC connector.

id str

The provider-assigned unique ID for this managed resource.

status str

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

tags_all Mapping[str, str]

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

vpc_connector_revision int

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

arn String

ARN of VPC connector.

id String

The provider-assigned unique ID for this managed resource.

status String

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

tagsAll Map<String>

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

vpcConnectorRevision Number

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

Look up Existing VpcConnector Resource

Get an existing VpcConnector 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?: VpcConnectorState, opts?: CustomResourceOptions): VpcConnector
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        security_groups: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        subnets: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_connector_name: Optional[str] = None,
        vpc_connector_revision: Optional[int] = None) -> VpcConnector
func GetVpcConnector(ctx *Context, name string, id IDInput, state *VpcConnectorState, opts ...ResourceOption) (*VpcConnector, error)
public static VpcConnector Get(string name, Input<string> id, VpcConnectorState? state, CustomResourceOptions? opts = null)
public static VpcConnector get(String name, Output<String> id, VpcConnectorState 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 VPC connector.

SecurityGroups List<string>

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

Status string

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

Subnets List<string>

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

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>

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

VpcConnectorName string

Name for the VPC connector.

VpcConnectorRevision int

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

Arn string

ARN of VPC connector.

SecurityGroups []string

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

Status string

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

Subnets []string

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

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

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

VpcConnectorName string

Name for the VPC connector.

VpcConnectorRevision int

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

arn String

ARN of VPC connector.

securityGroups List<String>

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

status String

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

subnets List<String>

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

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>

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

vpcConnectorName String

Name for the VPC connector.

vpcConnectorRevision Integer

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

arn string

ARN of VPC connector.

securityGroups string[]

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

status string

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

subnets string[]

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

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}

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

vpcConnectorName string

Name for the VPC connector.

vpcConnectorRevision number

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

arn str

ARN of VPC connector.

security_groups Sequence[str]

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

status str

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

subnets Sequence[str]

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

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]

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

vpc_connector_name str

Name for the VPC connector.

vpc_connector_revision int

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

arn String

ARN of VPC connector.

securityGroups List<String>

List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic.

status String

Current state of the VPC connector. If the status of a connector revision is INACTIVE, it was deleted and can't be used. Inactive connector revisions are permanently removed some time after they are deleted.

subnets List<String>

List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.

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>

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

vpcConnectorName String

Name for the VPC connector.

vpcConnectorRevision Number

The revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.

Import

App Runner vpc connector can be imported by using the arn, e.g.,

 $ pulumi import aws:apprunner/vpcConnector:VpcConnector example arn:aws:apprunner:us-east-1:1234567890:vpcconnector/example/1/0a03292a89764e5882c41d8f991c82fe

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.