API for Elastic Load Balancing

ABAP Package	/AWS1/API_ELB_IMPL
ABAP SDK "TLA"	ELB
ABAP Interface	/AWS1/IF_ELB

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

Elastic Load Balancing

A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. 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 and a protocol and port number for connections from the load balancer to the instances.

Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see the Elastic Load Balancing User Guide.

This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.

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_ELB_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_elb)       = /aws1/cl_elb_factory=>create( go_session ).

Your variable go_elb is an instance of /AWS1/IF_ELB, and all of the operations in the Elastic Load Balancing service are accessed by calling methods in /AWS1/IF_ELB.

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_ELB_FACTORY=>create( )

Creates an object of type /AWS1/IF_ELB.

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_elb /AWS1/IF_ELB

/AWS1/IF_ELB represents the ABAP client for the Elastic Load Balancing service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically

DATA(lo_config) = DATA(go_elb)->get_config( ).

lo_config is a variable of type /AWS1/CL_ELB_CONFIG. See the documentation for /AWS1/CL_ELB_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_ELB_WAITER`](./_AWS1_IF_ELB_WAITER.md).

Paginators

Paginators for Elastic Load Balancing can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_ELB_PAGINATOR`](./_AWS1_IF_ELB_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 Elastic Load Balancing can be found in interface [`/AWS1/IF_ELB_PAGINATOR`](./_AWS1_IF_ELB_PAGINATOR.md).