replace_vpn_tunnel¶
Operation¶
replace_vpn_tunnel
¶
replace_vpn_tunnel(request: ReplaceVpnTunnelInput | ReplaceVpnTunnelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ReplaceVpnTunnelInputDict]) -> ReplaceVpnTunnelOutput
Trigger replacement of specified VPN tunnel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ReplaceVpnTunnelInput | ReplaceVpnTunnelInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ReplaceVpnTunnelInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ReplaceVpnTunnelOutput
|
An instance of |
replace_vpn_tunnel
async
¶
replace_vpn_tunnel(request: ReplaceVpnTunnelInput | ReplaceVpnTunnelInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ReplaceVpnTunnelInputDict]) -> ReplaceVpnTunnelOutput
Trigger replacement of specified VPN tunnel.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ReplaceVpnTunnelInput | ReplaceVpnTunnelInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[ReplaceVpnTunnelInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ReplaceVpnTunnelOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ReplaceVpnTunnelInputDict
¶
Bases: TypedDict
Dictionary form of ReplaceVpnTunnelInput.
Attributes¶
apply_pending_maintenance
instance-attribute
¶
apply_pending_maintenance: bool | None
Trigger pending tunnel endpoint maintenance.
dry_run
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
instance-attribute
¶
The ID of the Site-to-Site VPN connection.
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.
Output¶
ReplaceVpnTunnelOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ReplaceVpnTunnelOutput structure.