EC2 / Client / get_vpn_connection_device_sample_configuration

get_vpn_connection_device_sample_configuration#

EC2.Client.get_vpn_connection_device_sample_configuration(**kwargs)#

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

Request Syntax

response = client.get_vpn_connection_device_sample_configuration(
    VpnConnectionId='string',
    VpnConnectionDeviceTypeId='string',
    InternetKeyExchangeVersion='string',
    DryRun=True|False
)
Parameters:

  • VpnConnectionId (string) –

    [REQUIRED]

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

  • VpnConnectionDeviceTypeId (string) –

    [REQUIRED]

    Device identifier provided by the GetVpnConnectionDeviceTypes API.

  • 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.

  • 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.

Return type:

dict

Returns:

Response Syntax

{
    'VpnConnectionDeviceSampleConfiguration': 'string'
}

Response Structure

  • (dict) –

    • VpnConnectionDeviceSampleConfiguration (string) –

      Sample configuration file for the specified customer gateway device.