# ClientVpnRouteOptions

Options for a ClientVpnRoute.

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

## Example

```ts
const endpoint = vpc.addClientVpnEndpoint('Endpoint', {
  cidr: '10.100.0.0/16',
  serverCertificateArn: 'arn:aws:acm:us-east-1:123456789012:certificate/server-certificate-id',
  userBasedAuthentication: ec2.ClientVpnUserBasedAuthentication.federated(samlProvider),
});

// Client-to-client access
endpoint.addRoute('Route', {
  cidr: '10.100.0.0/16',
  target: ec2.ClientVpnRouteTarget.local(),
});
```

## 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

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

  **Default:** no description

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