class VpcConnector (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.AppRunner.Alpha.VpcConnector
Go	github.com/aws/aws-cdk-go/awscdkapprunneralpha/v2#VpcConnector
Java	software.amazon.awscdk.services.apprunner.alpha.VpcConnector
Python	aws_cdk.aws_apprunner_alpha.VpcConnector
TypeScript (source)	@aws-cdk/aws-apprunner-alpha » VpcConnector

Implements IConstruct, IDependable, IResource, IVpcConnector, IConnectable

The App Runner VPC Connector.

Example

import * as ec2 from 'aws-cdk-lib/aws-ec2';

const vpc = new ec2.Vpc(this, 'Vpc', {
  ipAddresses: ec2.IpAddresses.cidr('10.0.0.0/16')
});

const vpcConnector = new apprunner.VpcConnector(this, 'VpcConnector', {
  vpc,
  vpcSubnets: vpc.selectSubnets({ subnetType: ec2.SubnetType.PUBLIC }),
  vpcConnectorName: 'MyVpcConnector',
});

new apprunner.Service(this, 'Service', {
  source: apprunner.Source.fromEcrPublic({
    imageConfiguration: { port: 8000 },
    imageIdentifier: 'public.ecr.aws/aws-containers/hello-app-runner:latest',
  }),
  vpcConnector,
});

Initializer

new VpcConnector(scope: Construct, id: string, props: VpcConnectorProps)

Parameters

• scope Construct
• id string
• props VpcConnectorProps

Construct Props

Name	Type	Description
vpc🔹	IVpc	The VPC for the VPC Connector.
securityGroups?🔹	ISecurityGroup[]	A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.
vpcConnectorName?🔹	string	The name for the VpcConnector.
vpcSubnets?🔹	SubnetSelection	Where to place the VPC Connector within the VPC.

---

vpc🔹

Type: IVpc

The VPC for the VPC Connector.

---

securityGroups?🔹

Type: ISecurityGroup[] (optional, default: a new security group will be created in the specified VPC)

A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets.

---

vpcConnectorName?🔹

Type: string (optional, default: a name generated by CloudFormation)

The name for the VpcConnector.

---

vpcSubnets?🔹

Type: SubnetSelection (optional, default: Private subnets.)

Where to place the VPC Connector within the VPC.

Properties

Name	Type	Description
connections🔹	Connections	Allows specifying security group connections for the VPC connector.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
vpcConnectorArn🔹	string	The ARN of the VPC connector.
vpcConnectorName🔹	string	The name of the VPC connector.
vpcConnectorRevision🔹	number	The revision of the VPC connector.

---

connections🔹

Type: Connections

Allows specifying security group connections for the VPC connector.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

vpcConnectorArn🔹

Type: string

The ARN of the VPC connector.

---

vpcConnectorName🔹

Type: string

The name of the VPC connector.

---

vpcConnectorRevision🔹

Type: number

The revision of the VPC connector.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
static fromVpcConnectorAttributes(scope, id, attrs)🔹	Import from VPC connector attributes.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromVpcConnectorAttributes(scope, id, attrs)🔹

public static fromVpcConnectorAttributes(scope: Construct, id: string, attrs: VpcConnectorAttributes): IVpcConnector

Parameters

• scope Construct
• id string
• attrs VpcConnectorAttributes

Returns

• IVpcConnector

Import from VPC connector attributes.