aws-cdk-lib/aws-ec2/lib/client-vpn-route.d.ts

Version 2 of the AWS Cloud Development Kit library

import { Construct } from 'constructs';
import { IClientVpnEndpoint } from './client-vpn-endpoint-types';
import { ISubnet } from './vpc';
import { Resource } from '../../core';
/**
 * Options for a ClientVpnRoute
 */
export interface ClientVpnRouteOptions {
    /**
     * 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
     */
    readonly cidr: string;
    /**
     * A brief description of the authorization rule.
     *
     * @default - no description
     */
    readonly description?: string;
    /**
     * The target for the route
     */
    readonly target: ClientVpnRouteTarget;
}
/**
 * Target for a client VPN route
 */
export declare abstract class ClientVpnRouteTarget {
    /**
     * Subnet
     *
     * The specified subnet must be an existing target network of the client VPN
     * endpoint.
     */
    static subnet(subnet: ISubnet): ClientVpnRouteTarget;
    /**
     * Local network
     */
    static local(): ClientVpnRouteTarget;
    /** The subnet ID */
    abstract readonly subnetId: string;
}
/**
 * Properties for a ClientVpnRoute
 */
export interface ClientVpnRouteProps extends ClientVpnRouteOptions {
    /**
     * The client VPN endpoint to which to add the route.
     * @default clientVpnEndpoint is required
     */
    readonly clientVpnEndpoint?: IClientVpnEndpoint;
}
/**
 * A client VPN route
 */
export declare class ClientVpnRoute extends Resource {
    constructor(scope: Construct, id: string, props: ClientVpnRouteProps);
}