Skip to content

API for Amazon DynamoDB Accelerator (DAX)

ABAP Package /AWS1/API_DAX_IMPL
ABAP SDK "TLA" DAX
ABAP Interface /AWS1/IF_DAX

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 DynamoDB Accelerator (DAX) is DAX. 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 DAX 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

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.

Using the SDK

In your code, create a client using the SDK module for Amazon DynamoDB Accelerator (DAX), which is created with factory method /AWS1/CL_DAX_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_dax)       = /aws1/cl_dax_factory=>create( go_session ).

Your variable go_dax is an instance of /AWS1/IF_DAX, and all of the operations in the Amazon DynamoDB Accelerator (DAX) service are accessed by calling methods in /AWS1/IF_DAX.

API Operations

For an overview of ABAP method calls corresponding to API operations in Amazon DynamoDB Accelerator (DAX), see the Operation List.

Factory Method

/AWS1/CL_DAX_FACTORY=>create( )

Creates an object of type /AWS1/IF_DAX.

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_DAX /AWS1/IF_DAX

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

Configuring Programmatically

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

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