Skip to content

/AWS1/IF_AZS=>CREATEPRACTICERUNCONF()

About CreatePracticeRunConfiguration

A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an outcome alarm, to monitor application health during practice runs and, optionally, a blocking alarm, to block practice runs from starting.

When a resource has a practice run configuration, ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.

For more information, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

Method Signature

IMPORTING

Required arguments:

iv_resourceidentifier TYPE /AWS1/AZSRESOURCEIDENTIFIER /AWS1/AZSRESOURCEIDENTIFIER

The identifier of the resource that Amazon Web Services shifts traffic for with a practice run zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:

it_outcomealarms TYPE /AWS1/CL_AZSCONTROLCONDITION=>TT_OUTCOMEALARMS TT_OUTCOMEALARMS

Outcome alarms for practice runs are alarms that you specify that end a practice run when one or more of the alarms is in an ALARM state.

Configure one or more of these alarms to monitor the health of your application when traffic is shifted away from an Availability Zone during each practice run. You should configure these alarms to go into an ALARM state if you want to stop a zonal shift, to let traffic for the resource return to the original Availability Zone.

Optional arguments:

it_blockedwindows TYPE /AWS1/CL_AZSBLOCKEDWINDOWS_W=>TT_BLOCKEDWINDOWS TT_BLOCKEDWINDOWS

Optionally, you can block ARC from starting practice runs for specific windows of days and times.

The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple blocked windows with spaces.

For example, say you run business report summaries three days a week. For this scenario, you could set the following recurring days and times as blocked windows, for example: Mon:00:00-Mon:10:00 Wed-20:30-Wed:21:30 Fri-20:30-Fri:21:30.

The blockedWindows have to start and end on the same day. Windows that span multiple days aren't supported.

it_blockeddates TYPE /AWS1/CL_AZSBLOCKEDDATES_W=>TT_BLOCKEDDATES TT_BLOCKEDDATES

Optionally, you can block ARC from starting practice runs for a resource on specific calendar dates.

The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Separate multiple blocked dates with spaces.

For example, if you have an application update scheduled to launch on May 1, 2024, and you don't want practice runs to shift traffic away at that time, you could set a blocked date for 2024-05-01.

it_blockingalarms TYPE /AWS1/CL_AZSCONTROLCONDITION=>TT_BLOCKINGALARMS TT_BLOCKINGALARMS

Blocking alarms for practice runs are optional alarms that you can specify that block practice runs when one or more of the alarms is in an ALARM state.

it_allowedwindows TYPE /AWS1/CL_AZSALLOWEDWINDOWS_W=>TT_ALLOWEDWINDOWS TT_ALLOWEDWINDOWS

Optionally, you can allow ARC to start practice runs for specific windows of days and times.

The format for allowed windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates, that dates and times for practice runs are in UTC. Also, be aware of potential time adjustments that might be required for daylight saving time differences. Separate multiple allowed windows with spaces.

For example, say you want to allow practice runs only on Wednesdays and Fridays from noon to 5 p.m. For this scenario, you could set the following recurring days and times as allowed windows, for example: Wed-12:00-Wed:17:00 Fri-12:00-Fri:17:00.

The allowedWindows have to start and end on the same day. Windows that span multiple days aren't supported.

RETURNING

oo_output TYPE REF TO /aws1/cl_azscrepracticerunco01 /AWS1/CL_AZSCREPRACTICERUNCO01

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_azs~createpracticerunconf(
  it_allowedwindows = VALUE /aws1/cl_azsallowedwindows_w=>tt_allowedwindows(
    ( new /aws1/cl_azsallowedwindows_w( |string| ) )
  )
  it_blockeddates = VALUE /aws1/cl_azsblockeddates_w=>tt_blockeddates(
    ( new /aws1/cl_azsblockeddates_w( |string| ) )
  )
  it_blockedwindows = VALUE /aws1/cl_azsblockedwindows_w=>tt_blockedwindows(
    ( new /aws1/cl_azsblockedwindows_w( |string| ) )
  )
  it_blockingalarms = VALUE /aws1/cl_azscontrolcondition=>tt_blockingalarms(
    (
      new /aws1/cl_azscontrolcondition(
        iv_alarmidentifier = |string|
        iv_type = |string|
      )
    )
  )
  it_outcomealarms = VALUE /aws1/cl_azscontrolcondition=>tt_outcomealarms(
    (
      new /aws1/cl_azscontrolcondition(
        iv_alarmidentifier = |string|
        iv_type = |string|
      )
    )
  )
  iv_resourceidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_resourcearn = lo_result->get_arn( ).
  lv_resourcename = lo_result->get_name( ).
  lv_zonalautoshiftstatus = lo_result->get_zonalautoshiftstatus( ).
  lo_practicerunconfiguratio = lo_result->get_practicerunconfiguration( ).
  IF lo_practicerunconfiguratio IS NOT INITIAL.
    LOOP AT lo_practicerunconfiguratio->get_blockingalarms( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_controlconditiontype = lo_row_1->get_type( ).
        lv_metricidentifier = lo_row_1->get_alarmidentifier( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_practicerunconfiguratio->get_outcomealarms( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_controlconditiontype = lo_row_1->get_type( ).
        lv_metricidentifier = lo_row_1->get_alarmidentifier( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_practicerunconfiguratio->get_blockedwindows( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_blockedwindow = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_practicerunconfiguratio->get_allowedwindows( ) into lo_row_4.
      lo_row_5 = lo_row_4.
      IF lo_row_5 IS NOT INITIAL.
        lv_allowedwindow = lo_row_5->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_practicerunconfiguratio->get_blockeddates( ) into lo_row_6.
      lo_row_7 = lo_row_6.
      IF lo_row_7 IS NOT INITIAL.
        lv_blockeddate = lo_row_7->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.