API for ARC - Region switch¶
| ABAP Package | /AWS1/API_R5A_IMPL |
|---|---|
| ABAP SDK "TLA" | R5A |
| ABAP Interface | /AWS1/IF_R5A |
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 ARC - Region switch is R5A.
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 ARC Region switch 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 Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another. You can test your plans in practice mode before using them in a real recovery scenario.
Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.
Using the SDK¶
In your code, create a client using the SDK module for ARC - Region switch, which is created with
factory method /AWS1/CL_R5A_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_r5a) = /aws1/cl_r5a_factory=>create( go_session ).
Your variable go_r5a is an instance of /AWS1/IF_R5A,
and all of the operations
in the ARC - Region switch service are accessed by calling methods in /AWS1/IF_R5A.
API Operations¶
For an overview of ABAP method calls corresponding to API operations in ARC - Region switch, see the Operation List.
Factory Method¶
/AWS1/CL_R5A_FACTORY=>create( )¶
Creates an object of type /AWS1/IF_R5A.
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_r5a /AWS1/IF_R5A¶
/AWS1/IF_R5Arepresents the ABAP client for the ARC Region switch service, representing each operation as a method call. For more information see the API Page page.
Configuring Programmatically¶
DATA(lo_config) = DATA(go_r5a)->get_config( ).
lo_config is a variable of type /AWS1/CL_R5A_CONFIG. See the documentation for /AWS1/CL_R5A_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_R5A_WAITER`](./_AWS1_IF_R5A_WAITER.md).
Paginators¶
Paginators for ARC - Region switch can be created via `get_paginator()` which returns a paginator object of type [`/AWS1/IF_R5A_PAGINATOR`](./_AWS1_IF_R5A_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 ARC - Region switch can be found in interface [`/AWS1/IF_R5A_PAGINATOR`](./_AWS1_IF_R5A_PAGINATOR.md).