# ClientVpnRouteProps

Properties for a ClientVpnRoute.

Extends: ClientVpnRouteProps
Extends: ClientVpnRouteOptions

- Source: [`aws-ec2/lib/client-vpn-route.ts`](https://github.com/aws/aws-cdk/blob/v2.273.0/packages/aws-cdk-lib/aws-ec2/lib/client-vpn-route.ts#L67)

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const clientVpnEndpoint: ec2.ClientVpnEndpoint;
declare const clientVpnRouteTarget: ec2.ClientVpnRouteTarget;
const clientVpnRouteProps: ec2.ClientVpnRouteProps = {
  cidr: 'cidr',
  target: clientVpnRouteTarget,

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

## Properties

- `cidr`: string (required) — 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

- `clientVpnEndpoint`: [IClientVpnEndpoint](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IClientVpnEndpoint.html) = clientVpnEndpoint is required — The client VPN endpoint to which to add the route.

- `description`: string = no description — A brief description of the authorization rule.

- `target`: [ClientVpnRouteTarget](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.ClientVpnRouteTarget.html) (required) — The target for the route.

## Used as props by

- [`ClientVpnRoute`](/v2/docs/aws-cdk-lib.aws_ec2.ClientVpnRoute)