CREATEROUTESERVERPEER()`¶

About CreateRouteServerPeer¶

Creates a new BGP peer for a specified route server endpoint.

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¶

METHODS /AWS1/IF_EC2~CREATEROUTESERVERPEER
  IMPORTING
    !IV_ROUTESERVERENDPOINTID TYPE /AWS1/EC2ROUTESERVERENDPOINTID OPTIONAL
    !IV_PEERADDRESS TYPE /AWS1/EC2STRING OPTIONAL
    !IO_BGPOPTIONS TYPE REF TO /AWS1/CL_EC2ROUTESERVERBGPOP00 OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2crerouteserverpe01
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_routeserverendpointid` `TYPE /AWS1/EC2ROUTESERVERENDPOINTID` `/AWS1/EC2ROUTESERVERENDPOINTID`¶

The ID of the route server endpoint for which to create a peer.

`iv_peeraddress` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The IPv4 address of the peer device.

`io_bgpoptions` `TYPE REF TO /AWS1/CL_EC2ROUTESERVERBGPOP00` `/AWS1/CL_EC2ROUTESERVERBGPOP00`¶

The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.

Optional arguments:¶

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

`it_tagspecifications` `TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST` `TT_TAGSPECIFICATIONLIST`¶

The tags to apply to the route server peer during creation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2crerouteserverpe01` `/AWS1/CL_EC2CREROUTESERVERPE01`¶

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->createrouteserverpeer(
  io_bgpoptions = new /aws1/cl_ec2routeserverbgpop00(
    iv_peerasn = 123
    iv_peerlivenessdetection = |string|
  )
  it_tagspecifications = VALUE /aws1/cl_ec2tagspecification=>tt_tagspecificationlist(
    (
      new /aws1/cl_ec2tagspecification(
        it_tags = VALUE /aws1/cl_ec2tag=>tt_taglist(
          (
            new /aws1/cl_ec2tag(
              iv_key = |string|
              iv_value = |string|
            )
          )
        )
        iv_resourcetype = |string|
      )
    )
  )
  iv_dryrun = ABAP_TRUE
  iv_peeraddress = |string|
  iv_routeserverendpointid = |string|
).

This is an example of reading all possible response values

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

/AWS1/IF_EC2=>CREATEROUTESERVERPEER()¶