API for Amazon VPC Lattice¶
| ABAP Package | /AWS1/API_VL_IMPL |
|---|---|
| ABAP SDK "TLA" | VL |
| ABAP Interface | /AWS1/IF_VL |
The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary
objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon VPC Lattice is VL.
This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.
Installation¶
To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the VPC Lattice module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.
About The Service¶
Amazon VPC Lattice is a fully managed application networking service that you use to connect, secure, and monitor all of your services across multiple accounts and virtual private clouds (VPCs). Amazon VPC Lattice interconnects your microservices and legacy services within a logical boundary, so that you can discover and manage them more efficiently. For more information, see the Amazon VPC Lattice User Guide
Using the SDK¶
In your code, create a client using the SDK module for Amazon VPC Lattice, which is created with
factory method /AWS1/CL_VL_FACTORY=>create().
In this example we will assume you have configured
an SDK profile in transaction /AWS1/IMG called ZFINANCE.
DATA(go_session) = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_vl) = /aws1/cl_vl_factory=>create( go_session ).
Your variable go_vl is an instance of /AWS1/IF_VL,
and all of the operations
in the Amazon VPC Lattice service are accessed by calling methods in /AWS1/IF_VL.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Amazon VPC Lattice, see the Operation List.
Factory Method¶
/AWS1/CL_VL_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_VL.
IMPORTING¶
Optional arguments:¶
iv_protocol TYPE /aws1/rt_protocol /AWS1/RT_PROTOCOL¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
io_session TYPE REF TO /aws1/cl_rt_session_base /AWS1/CL_RT_SESSION_BASE¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_region TYPE /aws1/rt_region_id /AWS1/RT_REGION_ID¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
iv_custom_endpoint TYPE /aws1/rt_endpoint /AWS1/RT_ENDPOINT¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC
RETURNING¶
oo_client TYPE REF TO /aws1/if_vl /AWS1/IF_VL¶
/AWS1/IF_VLrepresents the ABAP client for the VPC Lattice service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_vl)->get_config( ).
lo_config is a variable of type /AWS1/CL_VL_CONFIG. See the documentation for /AWS1/CL_VL_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for Amazon VPC Lattice can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_VL_PAGINATOR`](./_AWS1_IF_VL_PAGINATOR.md). The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using `has_next()` and `get_next()` methods.
Details about the paginator methods available for service Amazon VPC Lattice can be found in interface [`/AWS1/IF_VL_PAGINATOR`](./_AWS1_IF_VL_PAGINATOR.md).