GetVpnConnectionDeviceSampleConfiguration
Download an AWS-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.
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
- InternetKeyExchangeVersion
-
The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions:
ikev1orikev2.Type: String
Required: No
- VpnConnectionDeviceTypeId
-
Device identifier provided by the
GetVpnConnectionDeviceTypesAPI.Type: String
Required: Yes
- VpnConnectionId
-
The
VpnConnectionIdspecifies the Site-to-Site VPN connection used for the sample configuration.Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- vpnConnectionDeviceSampleConfiguration
-
Sample configuration file for the specified customer gateway device.
Type: String
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 AWS SDKs, see the following:
