modify_vpn_connection_options¶
Operation¶
modify_vpn_connection_options
async
¶
modify_vpn_connection_options(input: ModifyVpnConnectionOptionsInput, plugins: list[Plugin] | None = None) -> ModifyVpnConnectionOptionsOutput
Modifies the connection options for your Site-to-Site VPN connection.
When you modify the VPN connection options, the VPN endpoint IP addresses on the Amazon Web Services side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ModifyVpnConnectionOptionsInput
|
An instance of |
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 |
|---|---|
ModifyVpnConnectionOptionsOutput
|
An instance of |
Input¶
ModifyVpnConnectionOptionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyVpnConnectionOptionsInput 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.
local_ipv4_network_cidr
class-attribute
instance-attribute
¶
local_ipv4_network_cidr: str | None = ...
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
local_ipv6_network_cidr
class-attribute
instance-attribute
¶
local_ipv6_network_cidr: str | None = ...
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
remote_ipv4_network_cidr
class-attribute
instance-attribute
¶
remote_ipv4_network_cidr: str | None = ...
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
remote_ipv6_network_cidr
class-attribute
instance-attribute
¶
remote_ipv6_network_cidr: str | None = ...
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
tunnel_bandwidth
class-attribute
instance-attribute
¶
tunnel_bandwidth: str | None = ...
The desired bandwidth specification for the VPN connection. standard
supports up to 1.25 Gbps per tunnel, while large supports up to 5 Gbps
per tunnel. Large bandwidth is only available for VPN connections
attached to a transit gateway or to Cloud WAN. The default value is
standard.
Output¶
ModifyVpnConnectionOptionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ModifyVpnConnectionOptionsOutput 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
¶
Information about the VPN connection.