1.204.0

class ClientVpnRoute (construct)

This page is available in another version. Click here for the v2 documentation.

LanguageType name
.NETAmazon.CDK.AWS.EC2.ClientVpnRoute
Javasoftware.amazon.awscdk.services.ec2.ClientVpnRoute
Pythonaws_cdk.aws_ec2.ClientVpnRoute
TypeScript (source)@aws-cdk/aws-ec2 » ClientVpnRoute

Implements IConstruct, IConstruct, IDependable, IResource

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 * as ec2 from '@aws-cdk/aws-ec2';

declare const clientVpnEndpoint: ec2.ClientVpnEndpoint;
declare const clientVpnRouteTarget: ec2.ClientVpnRouteTarget;
const clientVpnRoute = new ec2.ClientVpnRoute(this, 'MyClientVpnRoute', {
  cidr: 'cidr',
  target: clientVpnRouteTarget,

  // the properties below are optional
  clientVpnEndoint: clientVpnEndpoint,
  clientVpnEndpoint: clientVpnEndpoint,
  description: 'description',
});

Initializer

new ClientVpnRoute(scope: Construct, id: string, props: ClientVpnRouteProps)

Parameters

Construct Props

NameTypeDescription
cidrstringThe IPv4 address range, in CIDR notation, of the route destination.
targetClientVpnRouteTargetThe target for the route.
clientVpnEndoint?⚠️IClientVpnEndpointThe client VPN endpoint to which to add the route.
clientVpnEndpoint?IClientVpnEndpointThe client VPN endpoint to which to add the route.
description?stringA brief description of the authorization rule.

cidr

Type: string

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

target

Type: ClientVpnRouteTarget

The target for the route.

clientVpnEndoint?⚠️

⚠️ Deprecated: Use clientVpnEndpoint instead

Type: IClientVpnEndpoint (optional, default: clientVpnEndpoint is required)

The client VPN endpoint to which to add the route.

clientVpnEndpoint?

Type: IClientVpnEndpoint (optional, default: clientVpnEndpoint is required)

The client VPN endpoint to which to add the route.

description?

Type: string (optional, default: no description)

A brief description of the authorization rule.

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeConstructNodeThe construct tree node associated with this construct.
stackStackThe stack in which this resource is defined.

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: ConstructNode

The construct tree node associated with this construct.

stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

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.

← PreviousNext →