CfnClientVpnRouteProps¶
-
class
aws_cdk.aws_ec2.
CfnClientVpnRouteProps
(*, client_vpn_endpoint_id, destination_cidr_block, target_vpc_subnet_id, description=None)¶ Bases:
object
Properties for defining a
CfnClientVpnRoute
.- Parameters
client_vpn_endpoint_id (
str
) – The ID of the Client VPN endpoint to which to add the route.destination_cidr_block (
str
) – The IPv4 address range, in CIDR notation, of the route destination. For example:. - To add a route for Internet access, enter0.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 rangetarget_vpc_subnet_id (
str
) – The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint. Alternatively, if you’re adding a route for the local network, specifylocal
.description (
Optional
[str
]) – A brief description of the route.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnroute.html
- ExampleMetadata
fixture=_generated
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 cfn_client_vpn_route_props = ec2.CfnClientVpnRouteProps( client_vpn_endpoint_id="clientVpnEndpointId", destination_cidr_block="destinationCidrBlock", target_vpc_subnet_id="targetVpcSubnetId", # the properties below are optional description="description" )
Attributes
-
client_vpn_endpoint_id
¶ The ID of the Client VPN endpoint to which to add the route.
-
description
¶ A brief description of the route.
-
destination_cidr_block
¶ .
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
- Link
- Type
The IPv4 address range, in CIDR notation, of the route destination. For example
- Return type
str
-
target_vpc_subnet_id
¶ The ID of the subnet through which you want to route traffic.
The specified subnet must be an existing target network of the Client VPN endpoint.
Alternatively, if you’re adding a route for the local network, specify
local
.