Skip to content

EC2  >  Operations  >  create_vpn_connection_route

create_vpn_connection_route

Operation

create_vpn_connection_route async

create_vpn_connection_route(request: CreateVpnConnectionRouteInput | CreateVpnConnectionRouteInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateVpnConnectionRouteOutput
create_vpn_connection_route(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateVpnConnectionRouteInputDict]) -> CreateVpnConnectionRouteOutput

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateVpnConnectionRouteOutput

An instance of CreateVpnConnectionRouteOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateVpnConnectionRouteInput dataclass

Bases: _SerdeShape

Contains the parameters for CreateVpnConnectionRoute.

Attributes
destination_cidr_block class-attribute instance-attribute
destination_cidr_block: str | None = ...

The CIDR block associated with the local subnet of the customer network.

vpn_connection_id class-attribute instance-attribute
vpn_connection_id: str | None = ...

The ID of the VPN connection.

Dictionaries

CreateVpnConnectionRouteInputDict

Bases: TypedDict

Dictionary form of CreateVpnConnectionRouteInput.

Attributes
destination_cidr_block instance-attribute
destination_cidr_block: Required[str]

The CIDR block associated with the local subnet of the customer network.

vpn_connection_id instance-attribute
vpn_connection_id: Required[str]

The ID of the VPN connection.

Output

CreateVpnConnectionRouteOutput dataclass

Bases: _SerdeShape

Dataclass for CreateVpnConnectionRouteOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.