VpcConnector class
Manages an App Runner VPC Connector.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const connector = new aws.apprunner.VpcConnector("connector", {
vpcConnectorName: "name",
subnets: [
"subnet1",
"subnet2",
],
securityGroups: [
"sg1",
"sg2",
],
});
import pulumi
import pulumi_aws as aws
connector = aws.apprunner.VpcConnector("connector",
vpc_connector_name="name",
subnets=[
"subnet1",
"subnet2",
],
security_groups=[
"sg1",
"sg2",
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var connector = new Aws.AppRunner.VpcConnector("connector", new()
{
VpcConnectorName = "name",
Subnets = new[]
{
"subnet1",
"subnet2",
},
SecurityGroups = new[]
{
"sg1",
"sg2",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
VpcConnectorName: pulumi.String("name"),
Subnets: pulumi.StringArray{
pulumi.String("subnet1"),
pulumi.String("subnet2"),
},
SecurityGroups: pulumi.StringArray{
pulumi.String("sg1"),
pulumi.String("sg2"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apprunner_vpcconnector" "connector" {
vpc_connector_name = "name"
subnets = ["subnet1", "subnet2"]
security_groups = ["sg1", "sg2"]
}
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.ArrayList;
import java.util.Arrays;
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()
.vpcConnectorName("name")
.subnets(
"subnet1",
"subnet2")
.securityGroups(
"sg1",
"sg2")
.build());
}
}
resources:
connector:
type: aws:apprunner:VpcConnector
properties:
vpcConnectorName: name
subnets:
- subnet1
- subnet2
securityGroups:
- sg1
- sg2
Import
Identity Schema
Required
arn(String) ARN of the App Runner VPC connector.
Using pulumi import, import App Runner vpc connector using the arn. For example:
$ pulumi import aws:apprunner/vpcConnector:VpcConnector example arn:aws:apprunner:us-east-1:1234567890:vpcconnector/example/1/0a03292a89764e5882c41d8f991c82fe
Constructors
- VpcConnector(String name, {VpcConnectorArgs? args, CustomResourceOptions? options})
-
Creates a new VpcConnector.
nameThe Pulumi resource name.argsArguments used to configure this VpcConnector. The set of arguments for VpcConnector.optionsResource options controlling this resource's behavior. - VpcConnector.reference(String urn)
- Creates a typed reference to an existing VpcConnector resource.
Properties
-
arn
↔ Output<
String> -
ARN of VPC connector.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
securityGroups
↔ Output<
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.
latefinal
-
status
↔ Output<
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.
latefinal
-
subnets
↔ Output<
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.
latefinal
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcConnectorName
↔ Output<
String> -
Name for the VPC connector.
latefinal
-
vpcConnectorRevision
↔ Output<
int> -
Revision of VPC connector. It's unique among all the active connectors ("Status": "ACTIVE") that share the same Name.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {VpcConnectorState? state, CustomResourceOptions? options}) → VpcConnector -
Gets an existing VpcConnector resource's state with the given
nameandid.