ModifyVpnTunnelOptions
Modifies the options for a VPN tunnel in an Amazon 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 Site-to-Site VPN User Guide.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
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 isUnauthorizedOperation.Type: Boolean
Required: No
- SkipTunnelReplacement
-
Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off
EnableTunnelLifecycleControl.Valid values:
True|FalseType: Boolean
Required: No
- TunnelOptions
-
The tunnel options to modify.
Type: ModifyVpnTunnelOptionsSpecification object
Required: Yes
- VpnConnectionId
-
The ID of the Amazon Site-to-Site VPN connection.
Type: String
Required: Yes
- VpnTunnelOutsideIpAddress
-
The external IP address of the VPN tunnel.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- vpnConnection
-
Information about the VPN connection.
Type: VpnConnection object
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: