VpcConnector

class aws_cdk.aws_apprunner.VpcConnector(scope, id, *, vpc, security_groups=None, vpc_connector_name=None, vpc_subnets=None)

Bases: Resource

(experimental) The App Runner VPC Connector.

Stability

experimental

Resource

AWS::AppRunner::VpcConnector

ExampleMetadata

infused

Example:

import aws_cdk.aws_ec2 as ec2


vpc = ec2.Vpc(self, "Vpc",
    cidr="10.0.0.0/16"
)

vpc_connector = apprunner.VpcConnector(self, "VpcConnector",
    vpc=vpc,
    vpc_subnets=vpc.select_subnets(subnet_type=ec2.SubnetType.PUBLIC),
    vpc_connector_name="MyVpcConnector"
)

apprunner.Service(self, "Service",
    source=apprunner.Source.from_ecr_public(
        image_configuration=apprunner.ImageConfiguration(port=8000),
        image_identifier="public.ecr.aws/aws-containers/hello-app-runner:latest"
    ),
    vpc_connector=vpc_connector
)
Parameters
  • scope (Construct) –

  • id (str) –

  • vpc (IVpc) – (experimental) The VPC for the VPC Connector.

  • security_groups (Optional[Sequence[ISecurityGroup]]) – (experimental) A list of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. Default: - a new security group will be created in the specified VPC

  • vpc_connector_name (Optional[str]) – (experimental) The name for the VpcConnector. Default: - a name generated by CloudFormation

  • vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – (experimental) Where to place the VPC Connector within the VPC. Default: - Private subnets.

Stability

experimental

Methods

apply_removal_policy(policy)

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).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

connections

(experimental) Allows specifying security group connections for the VPC connector.

Stability

experimental

Return type

Connections

env

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.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

vpc_connector_arn

(experimental) The ARN of the VPC connector.

Stability

experimental

Attribute

true

Return type

str

vpc_connector_name

(experimental) The name of the VPC connector.

Stability

experimental

Attribute

true

Return type

str

vpc_connector_revision

(experimental) The revision of the VPC connector.

Stability

experimental

Attribute

true

Return type

Union[int, float]

Static Methods

classmethod from_vpc_connector_attributes(scope, id, *, security_groups, vpc_connector_arn, vpc_connector_name, vpc_connector_revision)

(experimental) Import from VPC connector attributes.

Parameters
  • scope (Construct) –

  • id (str) –

  • security_groups (Sequence[ISecurityGroup]) – (experimental) The security groups associated with the VPC connector.

  • vpc_connector_arn (str) – (experimental) The ARN of the VPC connector.

  • vpc_connector_name (str) – (experimental) The name of the VPC connector.

  • vpc_connector_revision (Union[int, float]) – (experimental) The revision of the VPC connector.

Stability

experimental

Return type

IVpcConnector

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool