API for AWS ARC - Zonal Shift¶

ABAP Package	`/AWS1/API_AZS_IMPL`
ABAP SDK "TLA"	`AZS`
ABAP Interface	`/AWS1/IF_AZS`

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 ARC - Zonal Shift is AZS. 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 Zonal Shift 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¶

This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about zonal shift API actions, data types, and errors.

Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.

Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting a zonal shift helps your application recover immediately, for example, from a developer's bad code deployment or from an AWS infrastructure failure in a single Availability Zone, reducing the impact and time lost from an issue in one zone.

Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts in Route 53 ARC are managed resources in Route 53 ARC. You can start a zonal shift for any managed resource in your account in a Region. At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially. If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

For more information about using zonal shift, see the Amazon Route 53 Application Recovery Controller Developer Guide.

Using the SDK¶

In your code, create a client using the SDK module for AWS ARC - Zonal Shift, which is created with factory method /AWS1/CL_AZS_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_azs)       = /aws1/cl_azs_factory=>create( go_session ).

Your variable go_azs is an instance of /AWS1/IF_AZS, and all of the operations in the AWS ARC - Zonal Shift service are accessed by calling methods in /AWS1/IF_AZS.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in AWS ARC - Zonal Shift, see the Operation List.

Factory Method¶

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

Creates an object of type /AWS1/IF_AZS.

IMPORTING¶

Required arguments:¶

`IO_SESSION` `TYPE REF TO` `/AWS1/CL_RT_SESSION_BASE`¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE` `/AWS1/RT_PROTOCOL`¶

`IV_REGION` `TYPE` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO` `/AWS1/IF_AZS`¶

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

Configuring Programmatically¶

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

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

Paginators¶

Paginators for AWS ARC - Zonal Shift can be created via get_paginator() which returns a paginator object of type /AWS1/IF_AZS_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 AWS ARC - Zonal Shift can be found in interface /AWS1/IF_AZS_PAGINATOR.