DESCRIBEROUTESERVERPEERS()`¶

About DescribeRouteServerPeers¶

Describes one or more route server peers.

A route server peer is a session between a route server endpoint and the device deployed in Amazon Web Services (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements:

Have an elastic network interface in the VPC
Support BGP (Border Gateway Protocol)
Can initiate BGP sessions

For more information see Dynamic routing in your VPC with VPC Route Server in the Amazon VPC User Guide.

Method Signature¶

IMPORTING¶

Optional arguments:¶

`it_routeserverpeerids` `TYPE /AWS1/CL_EC2ROUTESERVERPEERI00=>TT_ROUTESERVERPEERIDSLIST` `TT_ROUTESERVERPEERIDSLIST`¶

The IDs of the route server peers to describe.

`iv_nexttoken` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The token for the next page of results.

`iv_maxresults` `TYPE /AWS1/EC2ROUTESERVERMAXRESULTS` `/AWS1/EC2ROUTESERVERMAXRESULTS`¶

The maximum number of results to return with a single call.

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

One or more filters to apply to the describe request.

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

A check for 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_ec2dscrouteserverpe01` `/AWS1/CL_EC2DSCROUTESERVERPE01`¶

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~describerouteserverpeers(
  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_routeserverpeerids = VALUE /aws1/cl_ec2routeserverpeeri00=>tt_routeserverpeeridslist(
    ( new /aws1/cl_ec2routeserverpeeri00( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_routeserverpeers( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_routeserverpeerid = lo_row_1->get_routeserverpeerid( ).
      lv_routeserverendpointid = lo_row_1->get_routeserverendpointid( ).
      lv_routeserverid = lo_row_1->get_routeserverid( ).
      lv_vpcid = lo_row_1->get_vpcid( ).
      lv_subnetid = lo_row_1->get_subnetid( ).
      lv_routeserverpeerstate = lo_row_1->get_state( ).
      lv_string = lo_row_1->get_failurereason( ).
      lv_networkinterfaceid = lo_row_1->get_endpointeniid( ).
      lv_string = lo_row_1->get_endpointeniaddress( ).
      lv_string = lo_row_1->get_peeraddress( ).
      lo_routeserverbgpoptions = lo_row_1->get_bgpoptions( ).
      IF lo_routeserverbgpoptions IS NOT INITIAL.
        lv_long = lo_routeserverbgpoptions->get_peerasn( ).
        lv_routeserverpeerliveness = lo_routeserverbgpoptions->get_peerlivenessdetection( ).
      ENDIF.
      lo_routeserverbgpstatus = lo_row_1->get_bgpstatus( ).
      IF lo_routeserverbgpstatus IS NOT INITIAL.
        lv_routeserverbgpstate = lo_routeserverbgpstatus->get_status( ).
      ENDIF.
      lo_routeserverbfdstatus = lo_row_1->get_bfdstatus( ).
      IF lo_routeserverbfdstatus IS NOT INITIAL.
        lv_routeserverbfdstate = lo_routeserverbfdstatus->get_status( ).
      ENDIF.
      LOOP AT lo_row_1->get_tags( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_key( ).
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/CL_EC2=>DESCRIBEROUTESERVERPEERS()¶