aws.apprunner.VpcIngressConnection
Explore with Pulumi AI
Manages an App Runner VPC Ingress Connection.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apprunner.VpcIngressConnection("example", {
name: "example",
serviceArn: exampleAwsApprunnerService.arn,
ingressVpcConfiguration: {
vpcId: _default.id,
vpcEndpointId: apprunner.id,
},
tags: {
foo: "bar",
},
});
import pulumi
import pulumi_aws as aws
example = aws.apprunner.VpcIngressConnection("example",
name="example",
service_arn=example_aws_apprunner_service["arn"],
ingress_vpc_configuration={
"vpc_id": default["id"],
"vpc_endpoint_id": apprunner["id"],
},
tags={
"foo": "bar",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apprunner"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apprunner.NewVpcIngressConnection(ctx, "example", &apprunner.VpcIngressConnectionArgs{
Name: pulumi.String("example"),
ServiceArn: pulumi.Any(exampleAwsApprunnerService.Arn),
IngressVpcConfiguration: &apprunner.VpcIngressConnectionIngressVpcConfigurationArgs{
VpcId: pulumi.Any(_default.Id),
VpcEndpointId: pulumi.Any(apprunner.Id),
},
Tags: pulumi.StringMap{
"foo": pulumi.String("bar"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.AppRunner.VpcIngressConnection("example", new()
{
Name = "example",
ServiceArn = exampleAwsApprunnerService.Arn,
IngressVpcConfiguration = new Aws.AppRunner.Inputs.VpcIngressConnectionIngressVpcConfigurationArgs
{
VpcId = @default.Id,
VpcEndpointId = apprunner.Id,
},
Tags =
{
{ "foo", "bar" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apprunner.VpcIngressConnection;
import com.pulumi.aws.apprunner.VpcIngressConnectionArgs;
import com.pulumi.aws.apprunner.inputs.VpcIngressConnectionIngressVpcConfigurationArgs;
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 VpcIngressConnection("example", VpcIngressConnectionArgs.builder()
.name("example")
.serviceArn(exampleAwsApprunnerService.arn())
.ingressVpcConfiguration(VpcIngressConnectionIngressVpcConfigurationArgs.builder()
.vpcId(default_.id())
.vpcEndpointId(apprunner.id())
.build())
.tags(Map.of("foo", "bar"))
.build());
}
}
resources:
example:
type: aws:apprunner:VpcIngressConnection
properties:
name: example
serviceArn: ${exampleAwsApprunnerService.arn}
ingressVpcConfiguration:
vpcId: ${default.id}
vpcEndpointId: ${apprunner.id}
tags:
foo: bar
Create VpcIngressConnection Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VpcIngressConnection(name: string, args: VpcIngressConnectionArgs, opts?: CustomResourceOptions);
@overload
def VpcIngressConnection(resource_name: str,
args: VpcIngressConnectionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VpcIngressConnection(resource_name: str,
opts: Optional[ResourceOptions] = None,
ingress_vpc_configuration: Optional[VpcIngressConnectionIngressVpcConfigurationArgs] = None,
service_arn: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewVpcIngressConnection(ctx *Context, name string, args VpcIngressConnectionArgs, opts ...ResourceOption) (*VpcIngressConnection, error)
public VpcIngressConnection(string name, VpcIngressConnectionArgs args, CustomResourceOptions? opts = null)
public VpcIngressConnection(String name, VpcIngressConnectionArgs args)
public VpcIngressConnection(String name, VpcIngressConnectionArgs args, CustomResourceOptions options)
type: aws:apprunner:VpcIngressConnection
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 VpcIngressConnectionArgs
- 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 VpcIngressConnectionArgs
- 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 VpcIngressConnectionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VpcIngressConnectionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VpcIngressConnectionArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var vpcIngressConnectionResource = new Aws.AppRunner.VpcIngressConnection("vpcIngressConnectionResource", new()
{
IngressVpcConfiguration = new Aws.AppRunner.Inputs.VpcIngressConnectionIngressVpcConfigurationArgs
{
VpcEndpointId = "string",
VpcId = "string",
},
ServiceArn = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := apprunner.NewVpcIngressConnection(ctx, "vpcIngressConnectionResource", &apprunner.VpcIngressConnectionArgs{
IngressVpcConfiguration: &apprunner.VpcIngressConnectionIngressVpcConfigurationArgs{
VpcEndpointId: pulumi.String("string"),
VpcId: pulumi.String("string"),
},
ServiceArn: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var vpcIngressConnectionResource = new VpcIngressConnection("vpcIngressConnectionResource", VpcIngressConnectionArgs.builder()
.ingressVpcConfiguration(VpcIngressConnectionIngressVpcConfigurationArgs.builder()
.vpcEndpointId("string")
.vpcId("string")
.build())
.serviceArn("string")
.name("string")
.tags(Map.of("string", "string"))
.build());
vpc_ingress_connection_resource = aws.apprunner.VpcIngressConnection("vpcIngressConnectionResource",
ingress_vpc_configuration={
"vpc_endpoint_id": "string",
"vpc_id": "string",
},
service_arn="string",
name="string",
tags={
"string": "string",
})
const vpcIngressConnectionResource = new aws.apprunner.VpcIngressConnection("vpcIngressConnectionResource", {
ingressVpcConfiguration: {
vpcEndpointId: "string",
vpcId: "string",
},
serviceArn: "string",
name: "string",
tags: {
string: "string",
},
});
type: aws:apprunner:VpcIngressConnection
properties:
ingressVpcConfiguration:
vpcEndpointId: string
vpcId: string
name: string
serviceArn: string
tags:
string: string
VpcIngressConnection 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 VpcIngressConnection resource accepts the following input properties:
- Ingress
Vpc VpcConfiguration Ingress Connection Ingress Vpc Configuration - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- Service
Arn string - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- Name string
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- 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.
- Ingress
Vpc VpcConfiguration Ingress Connection Ingress Vpc Configuration Args - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- Service
Arn string - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- Name string
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- 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.
- ingress
Vpc VpcConfiguration Ingress Connection Ingress Vpc Configuration - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- service
Arn String - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- name String
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- 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.
- ingress
Vpc VpcConfiguration Ingress Connection Ingress Vpc Configuration - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- service
Arn string - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- name string
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- {[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.
- ingress_
vpc_ Vpcconfiguration Ingress Connection Ingress Vpc Configuration Args - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- service_
arn str - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- name str
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- 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.
- ingress
Vpc Property MapConfiguration - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- service
Arn String - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- name String
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- 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 VpcIngressConnection resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- Domain
Name string - The domain name associated with the VPC Ingress Connection resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The current status of the VPC Ingress Connection.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- Domain
Name string - The domain name associated with the VPC Ingress Connection resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status string
- The current status of the VPC Ingress Connection.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- domain
Name String - The domain name associated with the VPC Ingress Connection resource.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The current status of the VPC Ingress Connection.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- domain
Name string - The domain name associated with the VPC Ingress Connection resource.
- id string
- The provider-assigned unique ID for this managed resource.
- status string
- The current status of the VPC Ingress Connection.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- domain_
name str - The domain name associated with the VPC Ingress Connection resource.
- id str
- The provider-assigned unique ID for this managed resource.
- status str
- The current status of the VPC Ingress Connection.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- domain
Name String - The domain name associated with the VPC Ingress Connection resource.
- id String
- The provider-assigned unique ID for this managed resource.
- status String
- The current status of the VPC Ingress Connection.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing VpcIngressConnection Resource
Get an existing VpcIngressConnection 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?: VpcIngressConnectionState, opts?: CustomResourceOptions): VpcIngressConnection
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
domain_name: Optional[str] = None,
ingress_vpc_configuration: Optional[VpcIngressConnectionIngressVpcConfigurationArgs] = None,
name: Optional[str] = None,
service_arn: Optional[str] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> VpcIngressConnection
func GetVpcIngressConnection(ctx *Context, name string, id IDInput, state *VpcIngressConnectionState, opts ...ResourceOption) (*VpcIngressConnection, error)
public static VpcIngressConnection Get(string name, Input<string> id, VpcIngressConnectionState? state, CustomResourceOptions? opts = null)
public static VpcIngressConnection get(String name, Output<String> id, VpcIngressConnectionState 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
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- Domain
Name string - The domain name associated with the VPC Ingress Connection resource.
- Ingress
Vpc VpcConfiguration Ingress Connection Ingress Vpc Configuration - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- Name string
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- Service
Arn string - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- Status string
- The current status of the VPC Ingress Connection.
- 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
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- Domain
Name string - The domain name associated with the VPC Ingress Connection resource.
- Ingress
Vpc VpcConfiguration Ingress Connection Ingress Vpc Configuration Args - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- Name string
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- Service
Arn string - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- Status string
- The current status of the VPC Ingress Connection.
- 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
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- domain
Name String - The domain name associated with the VPC Ingress Connection resource.
- ingress
Vpc VpcConfiguration Ingress Connection Ingress Vpc Configuration - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- name String
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- service
Arn String - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- status String
- The current status of the VPC Ingress Connection.
- 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
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- domain
Name string - The domain name associated with the VPC Ingress Connection resource.
- ingress
Vpc VpcConfiguration Ingress Connection Ingress Vpc Configuration - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- name string
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- service
Arn string - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- status string
- The current status of the VPC Ingress Connection.
- {[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
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- domain_
name str - The domain name associated with the VPC Ingress Connection resource.
- ingress_
vpc_ Vpcconfiguration Ingress Connection Ingress Vpc Configuration Args - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- name str
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- service_
arn str - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- status str
- The current status of the VPC Ingress Connection.
- 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
- The Amazon Resource Name (ARN) of the VPC Ingress Connection.
- domain
Name String - The domain name associated with the VPC Ingress Connection resource.
- ingress
Vpc Property MapConfiguration - Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See Ingress VPC Configuration below for more details.
- name String
- A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region.
- service
Arn String - The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource.
- status String
- The current status of the VPC Ingress Connection.
- 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.
Supporting Types
VpcIngressConnectionIngressVpcConfiguration, VpcIngressConnectionIngressVpcConfigurationArgs
- Vpc
Endpoint stringId - The ID of the VPC endpoint that your App Runner service connects to.
- Vpc
Id string - The ID of the VPC that is used for the VPC endpoint.
- Vpc
Endpoint stringId - The ID of the VPC endpoint that your App Runner service connects to.
- Vpc
Id string - The ID of the VPC that is used for the VPC endpoint.
- vpc
Endpoint StringId - The ID of the VPC endpoint that your App Runner service connects to.
- vpc
Id String - The ID of the VPC that is used for the VPC endpoint.
- vpc
Endpoint stringId - The ID of the VPC endpoint that your App Runner service connects to.
- vpc
Id string - The ID of the VPC that is used for the VPC endpoint.
- vpc_
endpoint_ strid - The ID of the VPC endpoint that your App Runner service connects to.
- vpc_
id str - The ID of the VPC that is used for the VPC endpoint.
- vpc
Endpoint StringId - The ID of the VPC endpoint that your App Runner service connects to.
- vpc
Id String - The ID of the VPC that is used for the VPC endpoint.
Import
Using pulumi import
, import App Runner VPC Ingress Connection using the arn
. For example:
$ pulumi import aws:apprunner/vpcIngressConnection:VpcIngressConnection example "arn:aws:apprunner:us-west-2:837424938642:vpcingressconnection/example/b379f86381d74825832c2e82080342fa"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.