vpn_connection_device_sample_configurations
Creates, updates, deletes, gets or lists a vpn_connection_device_sample_configurations resource.
Overview
| Name | vpn_connection_device_sample_configurations |
| Type | Resource |
| Id | aws.ec2.vpn_connection_device_sample_configurations |
Fields
The following fields are returned by SELECT queries:
- get_vpn_connection_device_sample_configuration
| Name | Datatype | Description |
|---|---|---|
vpn_connection_device_sample_configuration | string | Sample configuration file for the specified customer gateway device. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_vpn_connection_device_sample_configuration | select | VpnConnectionId, VpnConnectionDeviceTypeId, region | InternetKeyExchangeVersion, SampleType, DryRun | 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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
VpnConnectionDeviceTypeId | string | Device identifier provided by the GetVpnConnectionDeviceTypes API. |
VpnConnectionId | string | The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration. |
region | string | AWS region (default: us-east-1) |
DryRun | 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. |
InternetKeyExchangeVersion | 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. |
SampleType | string | The type of sample configuration to generate. Valid values are "compatibility" (includes IKEv1) or "recommended" (throws UnsupportedOperationException for IKEv1). |
SELECT examples
- get_vpn_connection_device_sample_configuration
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.
SELECT
vpn_connection_device_sample_configuration
FROM aws.ec2.vpn_connection_device_sample_configurations
WHERE VpnConnectionId = '{{ VpnConnectionId }}' -- required
AND VpnConnectionDeviceTypeId = '{{ VpnConnectionDeviceTypeId }}' -- required
AND region = '{{ region }}' -- required
AND InternetKeyExchangeVersion = '{{ InternetKeyExchangeVersion }}'
AND SampleType = '{{ SampleType }}'
AND DryRun = '{{ DryRun }}'
;