DESCRIBEVPNCONNECTIONS()`¶

About DescribeVpnConnections¶

Describes one or more of your VPN connections.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

One or more filters.

customer-gateway-configuration - The configuration information for the customer gateway.

customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

state - The state of the VPN connection (pending | available | deleting | deleted).

option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

type - The type of VPN connection. Currently the only supported type is ipsec.1.

vpn-connection-id - The ID of the VPN connection.

vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

transit-gateway-id - The ID of a transit gateway associated with the VPN connection.

`it_vpnconnectionids` `TYPE /AWS1/CL_EC2VPNCONNIDSTRLIST_W=>TT_VPNCONNECTIONIDSTRINGLIST` `TT_VPNCONNECTIONIDSTRINGLIST`¶

One or more VPN connection IDs.

Default: Describes your VPN connections.

`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_ec2descrvpnconnsrslt` `/AWS1/CL_EC2DESCRVPNCONNSRSLT`¶

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->/aws1/if_ec2~describevpnconnections(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_vpnconnectionids = VALUE /aws1/cl_ec2vpnconnidstrlist_w=>tt_vpnconnectionidstringlist(
    ( new /aws1/cl_ec2vpnconnidstrlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
).

This is an example of reading all possible response values

LOOP AT lo_result->get_vpnconnections( ) into lo_row.
  lv_string = lo_row_1->get_category( ).
  lv_string = lo_row_1->get_transitgatewayid( ).
  lv_string = lo_row_1->get_corenetworkarn( ).
  lv_string = lo_row_1->get_corenetworkattachmentarn( ).
  lv_gatewayassociationstate = lo_row_1->get_gatewayassociationstate( ).
  lv_boolean = lo_vpnconnectionoptions->get_enableacceleration( ).
  lv_boolean = lo_vpnconnectionoptions->get_staticroutesonly( ).
  lv_string = lo_vpnconnectionoptions->get_localipv4networkcidr( ).
  lv_string = lo_vpnconnectionoptions->get_remoteipv4networkcidr( ).
  lv_string = lo_vpnconnectionoptions->get_localipv6networkcidr( ).
  lv_string = lo_vpnconnectionoptions->get_remoteipv6networkcidr( ).
  lv_string = lo_vpnconnectionoptions->get_outsideipaddresstype( ).
  lv_string = lo_vpnconnectionoptions->get_transporttgwattachmentid( ).
  lv_tunnelinsideipversion = lo_vpnconnectionoptions->get_tunnelinsideipversion( ).
  LOOP AT lo_vpnconnectionoptions->get_tunneloptions( ) into lo_row_2.
    lv_string = lo_row_3->get_outsideipaddress( ).
    lv_string = lo_row_3->get_tunnelinsidecidr( ).
    lv_string = lo_row_3->get_tunnelinsideipv6cidr( ).
    lv_presharedkey = lo_row_3->get_presharedkey( ).
    lv_integer = lo_row_3->get_phase1lifetimeseconds( ).
    lv_integer = lo_row_3->get_phase2lifetimeseconds( ).
    lv_integer = lo_row_3->get_rekeymargintimeseconds( ).
    lv_integer = lo_row_3->get_rekeyfuzzpercentage( ).
    lv_integer = lo_row_3->get_replaywindowsize( ).
    lv_integer = lo_row_3->get_dpdtimeoutseconds( ).
    lv_string = lo_row_3->get_dpdtimeoutaction( ).
    LOOP AT lo_row_3->get_phase1encalgorithms( ) into lo_row_4.
      lv_string = lo_row_5->get_value( ).
    ENDLOOP.
    LOOP AT lo_row_3->get_phase2encalgorithms( ) into lo_row_6.
      lv_string = lo_row_7->get_value( ).
    ENDLOOP.
    LOOP AT lo_row_3->get_phase1integrityalgs( ) into lo_row_8.
      lv_string = lo_row_9->get_value( ).
    ENDLOOP.
    LOOP AT lo_row_3->get_phase2integrityalgs( ) into lo_row_10.
      lv_string = lo_row_11->get_value( ).
    ENDLOOP.
    LOOP AT lo_row_3->get_phase1dhgroupnumbers( ) into lo_row_12.
      lv_integer = lo_row_13->get_value( ).
    ENDLOOP.
    LOOP AT lo_row_3->get_phase2dhgroupnumbers( ) into lo_row_14.
      lv_integer = lo_row_15->get_value( ).
    ENDLOOP.
    LOOP AT lo_row_3->get_ikeversions( ) into lo_row_16.
      lv_string = lo_row_17->get_value( ).
    ENDLOOP.
    lv_string = lo_row_3->get_startupaction( ).
    lv_boolean = lo_cloudwatchlogoptions->get_logenabled( ).
    lv_string = lo_cloudwatchlogoptions->get_loggrouparn( ).
    lv_string = lo_cloudwatchlogoptions->get_logoutputformat( ).
    lv_boolean = lo_row_3->get_enabletunnellccontrol( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_routes( ) into lo_row_18.
    lv_string = lo_row_19->get_destinationcidrblock( ).
    lv_vpnstaticroutesource = lo_row_19->get_source( ).
    lv_vpnstate = lo_row_19->get_state( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_tags( ) into lo_row_20.
    lv_string = lo_row_21->get_key( ).
    lv_string = lo_row_21->get_value( ).
  ENDLOOP.
  LOOP AT lo_row_1->get_vgwtelemetry( ) into lo_row_22.
    lv_integer = lo_row_23->get_acceptedroutecount( ).
    lv_datetime = lo_row_23->get_laststatuschange( ).
    lv_string = lo_row_23->get_outsideipaddress( ).
    lv_telemetrystatus = lo_row_23->get_status( ).
    lv_string = lo_row_23->get_statusmessage( ).
    lv_string = lo_row_23->get_certificatearn( ).
  ENDLOOP.
  lv_string = lo_row_1->get_vpnconnectionid( ).
  lv_vpnstate = lo_row_1->get_state( ).
  lv_customergatewayconfigur = lo_row_1->get_customergatewayconf( ).
  lv_gatewaytype = lo_row_1->get_type( ).
  lv_string = lo_row_1->get_customergatewayid( ).
  lv_string = lo_row_1->get_vpngatewayid( ).
ENDLOOP.

/AWS1/CL_EC2=>DESCRIBEVPNCONNECTIONS()¶