ClientVpnRoute

class aws_cdk.aws_ec2.ClientVpnRoute(scope, id, *, client_vpn_endoint=None, client_vpn_endpoint=None, cidr, description=None, target)

Bases: aws_cdk.core.Resource

A client VPN route.

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2 as ec2

# client_vpn_endpoint is of type ClientVpnEndpoint
# client_vpn_route_target is of type ClientVpnRouteTarget

client_vpn_route = ec2.ClientVpnRoute(self, "MyClientVpnRoute",
    cidr="cidr",
    target=client_vpn_route_target,

    # the properties below are optional
    client_vpn_endoint=client_vpn_endpoint,
    client_vpn_endpoint=client_vpn_endpoint,
    description="description"
)
Parameters
  • scope (Construct) –

  • id (str) –

  • client_vpn_endoint (Optional[IClientVpnEndpoint]) – (deprecated) The client VPN endpoint to which to add the route. Default: clientVpnEndpoint is required

  • client_vpn_endpoint (Optional[IClientVpnEndpoint]) – The client VPN endpoint to which to add the route. Default: clientVpnEndpoint is required

  • cidr (str) – The IPv4 address range, in CIDR notation, of the route destination. For example: - To add a route for Internet access, enter 0.0.0.0/0 - To add a route for a peered VPC, enter the peered VPC’s IPv4 CIDR range - To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection’s IPv4 CIDR range - To add a route for the local network, enter the client CIDR range

  • description (Optional[str]) – A brief description of the authorization rule. Default: - no description

  • target (ClientVpnRouteTarget) – The target for the route.

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

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

Static Methods

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