API for Amazon Lightsail¶

ABAP Package	`/AWS1/API_LSA_IMPL`
ABAP SDK "TLA"	`LSA`
ABAP Interface	`/AWS1/IF_LSA`

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 Lightsail is LSA. 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 Lightsail 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 Lightsail is the easiest way to get started with Amazon Web Services (Amazon Web Services) for developers who need to build websites or web applications. It includes everything you need to launch your project quickly - instances (virtual private servers), container services, storage buckets, managed databases, SSD-based block storage, static IP addresses, load balancers, content delivery network (CDN) distributions, DNS management of registered domains, and resource snapshots (backups) - for a low, predictable monthly price.

You can manage your Lightsail resources using the Lightsail console, Lightsail API, Command Line Interface (CLI), or SDKs. For more information about Lightsail concepts and tasks, see the Amazon Lightsail Developer Guide.

This API Reference provides detailed information about the actions, data types, parameters, and errors of the Lightsail service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Lightsail service, see Amazon Lightsail Endpoints and Quotas in the Amazon Web Services General Reference.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Lightsail, which is created with factory method /AWS1/CL_LSA_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_lsa)       = /aws1/cl_lsa_factory=>create( go_session ).

Your variable go_lsa is an instance of /AWS1/IF_LSA, and all of the operations in the Amazon Lightsail service are accessed by calling methods in /AWS1/IF_LSA.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Lightsail, see the Operation List.

Factory Method¶

`/AWS1/CL_LSA_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_LSA.

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_LSA` `/AWS1/IF_LSA`¶

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

Configuring Programmatically¶

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

lo_config is a variable of type /AWS1/CL_LSA_CONFIG. See the documentation for /AWS1/CL_LSA_CONFIG for details on the settings that can be configured.