Get Vpn Connection Device Sample Configuration

ec2_get_vpn_connection_device_sample_configuration

R Documentation

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

Description

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.

Usage

ec2_get_vpn_connection_device_sample_configuration(VpnConnectionId,
  VpnConnectionDeviceTypeId, InternetKeyExchangeVersion, DryRun)

Arguments

VpnConnectionId

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

VpnConnectionDeviceTypeId

[required] Device identifier provided by the get_vpn_connection_device_types API.

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: ikev1 or ikev2.

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 is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  VpnConnectionDeviceSampleConfiguration = "string"
)

Request syntax

svc$get_vpn_connection_device_sample_configuration(
  VpnConnectionId = "string",
  VpnConnectionDeviceTypeId = "string",
  InternetKeyExchangeVersion = "string",
  DryRun = TRUE|FALSE
)