Skip to content

/AWS1/IF_EC2=>CREATECLIENTVPNROUTE()

About CreateClientVpnRoute

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

Method Signature

METHODS /AWS1/IF_EC2~CREATECLIENTVPNROUTE
  IMPORTING
    !IV_CLIENTVPNENDPOINTID TYPE /AWS1/EC2CLIENTVPNENDPOINTID OPTIONAL
    !IV_DESTINATIONCIDRBLOCK TYPE /AWS1/EC2STRING OPTIONAL
    !IV_TARGETVPCSUBNETID TYPE /AWS1/EC2SUBNETID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/EC2STRING OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2creclivpnrouterslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clientvpnendpointid TYPE /AWS1/EC2CLIENTVPNENDPOINTID /AWS1/EC2CLIENTVPNENDPOINTID

The ID of the Client VPN endpoint to which to add the route.

iv_destinationcidrblock TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The IPv4 address range, in CIDR notation, of the route destination. For example:

  • To add a route for Internet access, enter 0.0.0.0/0

  • To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range

  • To add a route for an on-premises network, enter the Amazon Web Services Site-to-Site VPN connection's IPv4 CIDR range

  • To add a route for the local network, enter the client CIDR range

iv_targetvpcsubnetid TYPE /AWS1/EC2SUBNETID /AWS1/EC2SUBNETID

The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

Alternatively, if you're adding a route for the local network, specify local.

Optional arguments:

iv_description TYPE /AWS1/EC2STRING /AWS1/EC2STRING

A brief description of the route.

iv_clienttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

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_ec2creclivpnrouterslt /AWS1/CL_EC2CRECLIVPNROUTERSLT

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->createclientvpnroute(
  iv_clienttoken = |string|
  iv_clientvpnendpointid = |string|
  iv_description = |string|
  iv_destinationcidrblock = |string|
  iv_dryrun = ABAP_TRUE
  iv_targetvpcsubnetid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_clientvpnroutestatus = lo_result->get_status( ).
  IF lo_clientvpnroutestatus IS NOT INITIAL.
    lv_clientvpnroutestatuscod = lo_clientvpnroutestatus->get_code( ).
    lv_string = lo_clientvpnroutestatus->get_message( ).
  ENDIF.
ENDIF.