GETVPNCONNDEVICESAMPLECONF()`¶

About GetVpnConnectionDeviceSampleConfiguration¶

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.

Method Signature¶

METHODS /AWS1/IF_EC2~GETVPNCONNDEVICESAMPLECONF
  IMPORTING
    !IV_VPNCONNECTIONID TYPE /AWS1/EC2VPNCONNECTIONID OPTIONAL
    !IV_VPNCONNECTIONDEVICETYPEID TYPE /AWS1/EC2VPNCONNDEVICETYPEID OPTIONAL
    !IV_INTERNETKEYEXCHANGEVRS TYPE /AWS1/EC2STRING OPTIONAL
    !IV_SAMPLETYPE TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2getvpncxndevsamp01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_vpnconnectionid` `TYPE /AWS1/EC2VPNCONNECTIONID` `/AWS1/EC2VPNCONNECTIONID`¶

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

`iv_vpnconnectiondevicetypeid` `TYPE /AWS1/EC2VPNCONNDEVICETYPEID` `/AWS1/EC2VPNCONNDEVICETYPEID`¶

Device identifier provided by the GetVpnConnectionDeviceTypes API.

Optional arguments:¶

`iv_internetkeyexchangevrs` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

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.

`iv_sampletype` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The type of sample configuration to generate. Valid values are "compatibility" (includes IKEv1) or "recommended" (throws UnsupportedOperationException for IKEv1).

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2getvpncxndevsamp01` `/AWS1/CL_EC2GETVPNCXNDEVSAMP01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getvpnconndevicesampleconf(
  iv_dryrun = ABAP_TRUE
  iv_internetkeyexchangevrs = |string|
  iv_sampletype = |string|
  iv_vpnconnectiondevicetypeid = |string|
  iv_vpnconnectionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_vpnconnectiondevicesamp = lo_result->get_vpnconndevicesampleconf( ).
ENDIF.

/AWS1/IF_EC2=>GETVPNCONNDEVICESAMPLECONF()¶