modify_vpn_tunnel_options¶
Operation¶
modify_vpn_tunnel_options
async
¶
modify_vpn_tunnel_options(request: ModifyVpnTunnelOptionsInput | ModifyVpnTunnelOptionsInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyVpnTunnelOptionsOutput
modify_vpn_tunnel_options(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyVpnTunnelOptionsInputDict]) -> ModifyVpnTunnelOptionsOutput
Modifies the options for a VPN tunnel in an Amazon Web Services Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN tunnel options for your Site-to-Site VPN connection 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 |
|---|---|
ModifyVpnTunnelOptionsOutput
|
An instance of |
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¶
ModifyVpnTunnelOptionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyVpnTunnelOptionsInput structure.
Attributes¶
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.
pre_shared_key_storage
class-attribute
instance-attribute
¶
pre_shared_key_storage: str | None = ...
Specifies the storage mode for the pre-shared key (PSK). Valid values
are Standard (stored in Site-to-Site VPN service) or SecretsManager
(stored in Amazon Web Services Secrets Manager).
skip_tunnel_replacement
class-attribute
instance-attribute
¶
skip_tunnel_replacement: bool | None = ...
Choose whether or not to trigger immediate tunnel replacement. This is
only applicable when turning on or off EnableTunnelLifecycleControl.
Valid values: True | False
tunnel_options
class-attribute
instance-attribute
¶
tunnel_options: ModifyVpnTunnelOptionsSpecification | None = ...
The tunnel options to modify.
Dictionaries¶
ModifyVpnTunnelOptionsInputDict
¶
Bases: TypedDict
Dictionary form of ModifyVpnTunnelOptionsInput.
Attributes¶
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.
pre_shared_key_storage
instance-attribute
¶
pre_shared_key_storage: str | None
Specifies the storage mode for the pre-shared key (PSK). Valid values
are Standard (stored in Site-to-Site VPN service) or SecretsManager
(stored in Amazon Web Services Secrets Manager).
skip_tunnel_replacement
instance-attribute
¶
skip_tunnel_replacement: bool | None
Choose whether or not to trigger immediate tunnel replacement. This is
only applicable when turning on or off EnableTunnelLifecycleControl.
Valid values: True | False
tunnel_options
instance-attribute
¶
tunnel_options: Required[ModifyVpnTunnelOptionsSpecification | ModifyVpnTunnelOptionsSpecificationDict]
The tunnel options to modify.
vpn_connection_id
instance-attribute
¶
The ID of the Amazon Web Services Site-to-Site VPN connection.
Output¶
ModifyVpnTunnelOptionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyVpnTunnelOptionsOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
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.
vpn_connection
class-attribute
instance-attribute
¶
vpn_connection: VpnConnection | None = ...
Information about the VPN connection.