VpcConnector

class aws_cdk.aws_apprunner_alpha.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",
    ip_addresses=ec2.IpAddresses.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

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.

node: The tree node.

stack: The stack in which this resource is defined.

vpc_connector_arn

(experimental) The ARN of the VPC connector.

Stability:: experimental
Attribute:: true

vpc_connector_name

(experimental) The name of the VPC connector.

Stability:: experimental
Attribute:: true

vpc_connector_revision

(experimental) The revision of the VPC connector.

Stability:: experimental
Attribute:: true

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

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool