Skip to content

EC2  >  Operations  >  replace_vpn_tunnel

replace_vpn_tunnel

Operation

replace_vpn_tunnel async 

replace_vpn_tunnel(input: ReplaceVpnTunnelInput, plugins: list[Plugin] | None = None) -> ReplaceVpnTunnelOutput

Trigger replacement of specified VPN tunnel.

Parameters:

Name Type Description Default
input ReplaceVpnTunnelInput

An instance of ReplaceVpnTunnelInput.

 required
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
ReplaceVpnTunnelOutput

An instance of ReplaceVpnTunnelOutput.

Input

ReplaceVpnTunnelInput dataclass

Bases: _SerdeShape

Dataclass for ReplaceVpnTunnelInput structure.

Attributes

apply_pending_maintenance class-attribute instance-attribute 
apply_pending_maintenance: bool | None = ...

Trigger pending tunnel endpoint maintenance.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

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

The ID of the Site-to-Site VPN connection.

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

The external IP address of the VPN tunnel.

Output

ReplaceVpnTunnelOutput dataclass

Bases: _SerdeShape

Dataclass for ReplaceVpnTunnelOutput 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.

return_ class-attribute instance-attribute 
return_: bool | None = ...

Confirmation of replace tunnel operation.