API for AWS RDS DataService¶

ABAP Package	`/AWS1/API_RDD_IMPL`
ABAP SDK "TLA"	`RDD`
ABAP Interface	`/AWS1/IF_RDD`

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 RDS DataService is RDD. 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 RDS Data 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¶

RDS Data API

Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora DB cluster. To run these statements, you use the RDS Data API (Data API).

Data API is available with the following types of Aurora databases:

Aurora PostgreSQL - Serverless v2, Serverless v1, and provisioned
Aurora MySQL - Serverless v1 only

For more information about the Data API, see Using RDS Data API in the Amazon Aurora User Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS RDS DataService, which is created with factory method /AWS1/CL_RDD_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_rdd)       = /aws1/cl_rdd_factory=>create( go_session ).

Your variable go_rdd is an instance of /AWS1/IF_RDD, and all of the operations in the AWS RDS DataService service are accessed by calling methods in /AWS1/IF_RDD.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS RDS DataService, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_RDD.

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_RDD` `/AWS1/IF_RDD`¶

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

Configuring Programmatically¶

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

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