API for Elastic Load Balancing¶
ABAP Package | /AWS1/API_EL2_IMPL |
---|---|
ABAP SDK "TLA" | EL2 |
ABAP Interface | /AWS1/IF_EL2 |
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 Elastic Load Balancing is EL2
.
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 Elastic Load Balancing v2 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¶
A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.
Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. This reference covers the following load balancer types:
-
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
-
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
-
Gateway Load Balancer - Operates at the network layer (layer 3).
For more information, see the Elastic Load Balancing User Guide.
All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.
Using the SDK¶
In your code, create a client using the SDK module for Elastic Load Balancing, which is created with
factory method /AWS1/CL_EL2_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_el2) = /aws1/cl_el2_factory=>create( go_session ).
Your variable go_el2
is an instance of /AWS1/IF_EL2
,
and all of the operations
in the Elastic Load Balancing service are accessed by calling methods in /AWS1/IF_EL2
.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in Elastic Load Balancing, see the Operation List.
Factory Method¶
/AWS1/CL_EL2_FACTORY=>create( )
¶
Creates an object of type /AWS1/IF_EL2
.
IMPORTING¶
Optional arguments:¶
IV_PROTOCOL
TYPE /AWS1/RT_PROTOCOL
/AWS1/RT_PROTOCOL
¶
IO_SESSION
TYPE REF TO /AWS1/CL_RT_SESSION_BASE
/AWS1/CL_RT_SESSION_BASE
¶
IV_REGION
TYPE /AWS1/RT_REGION_ID
/AWS1/RT_REGION_ID
¶
IV_CUSTOM_ENDPOINT
TYPE /AWS1/RT_ENDPOINT
/AWS1/RT_ENDPOINT
¶
RETURNING¶
OO_CLIENT
TYPE REF TO /AWS1/IF_EL2
/AWS1/IF_EL2
¶
/AWS1/IF_EL2
represents the ABAP client for the Elastic Load Balancing v2 service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_el2)->get_config( ).
lo_config
is a variable of type /AWS1/CL_EL2_CONFIG
. See the documentation for /AWS1/CL_EL2_CONFIG
for
details on the settings that can be configured.
Waiters¶
Waiters for Implementation can be accessed via get_waiter()
method followed by the waiter method to be called.
Details about the waiter methods available for service Implementation can be found in interface /AWS1/IF_EL2_WAITER
.
Paginators¶
Paginators for Elastic Load Balancing can be created via get_paginator()
which returns a paginator object of type /AWS1/IF_EL2_PAGINATOR
. 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 Elastic Load Balancing can be found in interface /AWS1/IF_EL2_PAGINATOR
.