ClientVpnRouteProps¶
-
class
aws_cdk.aws_ec2.
ClientVpnRouteProps
(*, cidr, target, description=None, client_vpn_endoint=None, client_vpn_endpoint=None)¶ Bases:
aws_cdk.aws_ec2.ClientVpnRouteOptions
Properties for a ClientVpnRoute.
- Parameters
cidr (
str
) – 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 rangetarget (
ClientVpnRouteTarget
) – The target for the route.description (
Optional
[str
]) – A brief description of the authorization rule. Default: - no descriptionclient_vpn_endoint (
Optional
[IClientVpnEndpoint
]) – (deprecated) The client VPN endpoint to which to add the route. Default: clientVpnEndpoint is requiredclient_vpn_endpoint (
Optional
[IClientVpnEndpoint
]) – The client VPN endpoint to which to add the route. Default: clientVpnEndpoint is required
- 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 # client_vpn_endpoint: ec2.ClientVpnEndpoint # client_vpn_route_target: ec2.ClientVpnRouteTarget client_vpn_route_props = ec2.ClientVpnRouteProps( cidr="cidr", target=client_vpn_route_target, # the properties below are optional client_vpn_endoint=client_vpn_endpoint, client_vpn_endpoint=client_vpn_endpoint, description="description" )
Attributes
-
cidr
¶ 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
- Return type
str
-
client_vpn_endoint
¶ (deprecated) The client VPN endpoint to which to add the route.
- Default
clientVpnEndpoint is required
- Deprecated
Use
clientVpnEndpoint
instead- Stability
deprecated
- Return type
Optional
[IClientVpnEndpoint
]
-
client_vpn_endpoint
¶ The client VPN endpoint to which to add the route.
- Default
clientVpnEndpoint is required
- Return type
Optional
[IClientVpnEndpoint
]
-
description
¶ A brief description of the authorization rule.
- Default
no description
- Return type
Optional
[str
]
-
target
¶ The target for the route.
- Return type