API for AWS App Mesh¶
| ABAP Package | /AWS1/API_APM_IMPL |
|---|---|
| ABAP SDK "TLA" | APM |
| ABAP Interface | /AWS1/IF_APM |
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 AWS App Mesh is APM.
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 App Mesh 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¶
App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.
App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with Amazon Web Services Fargate, Amazon ECS, Amazon EKS, Kubernetes on Amazon Web Services, and Amazon EC2.
App Mesh supports microservice applications that use service discovery
naming for their components. For more information about service discovery on Amazon ECS, see Service
Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes
kube-dns and coredns are supported. For more information,
see DNS
for Services and Pods in the Kubernetes documentation.
Using the SDK¶
In your code, create a client using the SDK module for AWS App Mesh, which is created with
factory method /AWS1/CL_APM_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_apm) = /aws1/cl_apm_factory=>create( go_session ).
Your variable go_apm is an instance of /AWS1/IF_APM,
and all of the operations
in the AWS App Mesh service are accessed by calling methods in /AWS1/IF_APM.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in AWS App Mesh, see the Operation List.
Factory Method¶
/AWS1/CL_APM_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_APM.
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_apm /AWS1/IF_APM¶
/AWS1/IF_APMrepresents the ABAP client for the App Mesh service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_apm)->get_config( ).
lo_config is a variable of type /AWS1/CL_APM_CONFIG. See the documentation for /AWS1/CL_APM_CONFIG for
details on the settings that can be configured.
Paginators¶
Paginators for AWS App Mesh can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_APM_PAGINATOR`](./_AWS1_IF_APM_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 AWS App Mesh can be found in interface [`/AWS1/IF_APM_PAGINATOR`](./_AWS1_IF_APM_PAGINATOR.md).