API for Amazon DocumentDB Elastic Clusters¶

ABAP Package	`/AWS1/API_DOE_IMPL`
ABAP SDK "TLA"	`DOE`
ABAP Interface	`/AWS1/IF_DOE`

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 DocumentDB Elastic Clusters is DOE. 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 DocDB Elastic 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 DocumentDB elastic clusters

Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.

Amazon DocumentDB elastic-clusters were created to:

provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.
give customers higher connection limits, and to reduce downtime from patching.
continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.

Using the SDK¶

In your code, create a client using the SDK module for Amazon DocumentDB Elastic Clusters, which is created with factory method /AWS1/CL_DOE_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_doe)       = /aws1/cl_doe_factory=>create( go_session ).

Your variable go_doe is an instance of /AWS1/IF_DOE, and all of the operations in the Amazon DocumentDB Elastic Clusters service are accessed by calling methods in /AWS1/IF_DOE.

API Operations¶

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

Factory Method¶

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

Creates an object of type /AWS1/IF_DOE.

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_DOE` `/AWS1/IF_DOE`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for Amazon DocumentDB Elastic Clusters can be created via get_paginator() which returns a paginator object of type /AWS1/IF_DOE_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 Amazon DocumentDB Elastic Clusters can be found in interface /AWS1/IF_DOE_PAGINATOR.