[ aws . ec2 ]



Download an Amazon Web Services-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--vpn-connection-id <value>
--vpn-connection-device-type-id <value>
[--internet-key-exchange-version <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--vpn-connection-id (string)

The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.

--vpn-connection-device-type-id (string)

Device identifier provided by the GetVpnConnectionDeviceTypes API.

--internet-key-exchange-version (string)

The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2 .

--dry-run | --no-dry-run (boolean)

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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.


VpnConnectionDeviceSampleConfiguration -> (string)

Sample configuration file for the specified customer gateway device.