practice_run_configurations

Creates, updates, deletes, gets or lists a practice_run_configurations resource.

Overview

Name	practice_run_configurations
Type	Resource
Id	aws.arc_zonal_shift.practice_run_configurations

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_practice_run_configuration	insert	region, resourceIdentifier, outcomeAlarms		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.
update_practice_run_configuration	update	resource_identifier, region		Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.
delete_practice_run_configuration	delete	resource_identifier, region		Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
resource_identifier	string	The identifier for the resource that you want to delete the practice run configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.

INSERT examples

create_practice_run_configuration

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.

INSERT INTO aws.arc_zonal_shift.practice_run_configurations (
resourceIdentifier,
blockedWindows,
blockedDates,
blockingAlarms,
allowedWindows,
outcomeAlarms,
region
)
SELECT 
'{{ resourceIdentifier }}' /* required */,
'{{ blockedWindows }}',
'{{ blockedDates }}',
'{{ blockingAlarms }}',
'{{ allowedWindows }}',
'{{ outcomeAlarms }}' /* required */,
'{{ region }}'
RETURNING
name,
arn,
practice_run_configuration,
zonal_autoshift_status
;

Manifest

# Description fields are for documentation purposes
- name: practice_run_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the practice_run_configurations resource.
  - name: resourceIdentifier
    value: "{{ resourceIdentifier }}"
  - name: blockedWindows
    value:
      - "{{ blockedWindows }}"
  - name: blockedDates
    value:
      - "{{ blockedDates }}"
  - name: blockingAlarms
    value:
      - type_: "{{ type_ }}"
        alarmIdentifier: "{{ alarmIdentifier }}"
  - name: allowedWindows
    value:
      - "{{ allowedWindows }}"
  - name: outcomeAlarms
    value:
      - type_: "{{ type_ }}"
        alarmIdentifier: "{{ alarmIdentifier }}"

UPDATE examples

update_practice_run_configuration

Update a practice run configuration to change one or more of the following: add, change, or remove the blocking alarm; change the outcome alarm; or add, change, or remove blocking dates or time windows.

UPDATE aws.arc_zonal_shift.practice_run_configurations
SET 
blockedWindows = '{{ blockedWindows }}',
blockedDates = '{{ blockedDates }}',
blockingAlarms = '{{ blockingAlarms }}',
allowedWindows = '{{ allowedWindows }}',
outcomeAlarms = '{{ outcomeAlarms }}'
WHERE 
resource_identifier = '{{ resource_identifier }}' --required
AND region = '{{ region }}' --required
RETURNING
name,
arn,
practice_run_configuration,
zonal_autoshift_status;

DELETE examples

delete_practice_run_configuration

Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.

DELETE FROM aws.arc_zonal_shift.practice_run_configurations
WHERE resource_identifier = '{{ resource_identifier }}' --required
AND region = '{{ region }}' --required
;