restore_testing_plans

Creates, updates, deletes or gets a restore_testing_plan resource or lists restore_testing_plans in a region

Overview

Name	restore_testing_plans
Type	Resource
Description	Definition of AWS::Backup::RestoreTestingPlan Resource Type
Id	aws.backup.restore_testing_plans

Fields

Name	Datatype	Description
recovery_point_selection	object
restore_testing_plan_arn	string
restore_testing_plan_name	string
schedule_expression	string
schedule_expression_timezone	string
start_window_hours	integer
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RecoveryPointSelection, ScheduleExpression, RestoreTestingPlanName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all restore_testing_plans in a region.

SELECT
region,
recovery_point_selection,
restore_testing_plan_arn,
restore_testing_plan_name,
schedule_expression,
schedule_expression_timezone,
start_window_hours,
tags
FROM aws.backup.restore_testing_plans
WHERE region = 'us-east-1';

Gets all properties from an individual restore_testing_plan.

SELECT
region,
recovery_point_selection,
restore_testing_plan_arn,
restore_testing_plan_name,
schedule_expression,
schedule_expression_timezone,
start_window_hours,
tags
FROM aws.backup.restore_testing_plans
WHERE region = 'us-east-1' AND data__Identifier = '<RestoreTestingPlanName>';

INSERT example

Use the following StackQL query and manifest file to create a new restore_testing_plan resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.backup.restore_testing_plans (
 RecoveryPointSelection,
 RestoreTestingPlanName,
 ScheduleExpression,
 region
)
SELECT 
'{{ RecoveryPointSelection }}',
 '{{ RestoreTestingPlanName }}',
 '{{ ScheduleExpression }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.backup.restore_testing_plans (
 RecoveryPointSelection,
 RestoreTestingPlanName,
 ScheduleExpression,
 ScheduleExpressionTimezone,
 StartWindowHours,
 Tags,
 region
)
SELECT 
 '{{ RecoveryPointSelection }}',
 '{{ RestoreTestingPlanName }}',
 '{{ ScheduleExpression }}',
 '{{ ScheduleExpressionTimezone }}',
 '{{ StartWindowHours }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: restore_testing_plan
    props:
      - name: RecoveryPointSelection
        value:
          Algorithm: '{{ Algorithm }}'
          SelectionWindowDays: '{{ SelectionWindowDays }}'
          RecoveryPointTypes:
            - '{{ RecoveryPointTypes[0] }}'
          IncludeVaults:
            - '{{ IncludeVaults[0] }}'
          ExcludeVaults:
            - '{{ ExcludeVaults[0] }}'
      - name: RestoreTestingPlanName
        value: '{{ RestoreTestingPlanName }}'
      - name: ScheduleExpression
        value: '{{ ScheduleExpression }}'
      - name: ScheduleExpressionTimezone
        value: '{{ ScheduleExpressionTimezone }}'
      - name: StartWindowHours
        value: '{{ StartWindowHours }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.backup.restore_testing_plans
WHERE data__Identifier = '<RestoreTestingPlanName>'
AND region = 'us-east-1';

Permissions

To operate on the restore_testing_plans resource, the following permissions are required:

Create

backup:CreateRestoreTestingPlan,
backup:TagResource,
backup:GetRestoreTestingPlan,
backup:ListTags

Read

backup:GetRestoreTestingPlan,
backup:ListTags

Update

backup:UpdateRestoreTestingPlan,
backup:TagResource,
backup:UntagResource,
backup:GetRestoreTestingPlan,
backup:ListTags

Delete

backup:DeleteRestoreTestingPlan,
backup:GetRestoreTestingPlan

List

backup:ListRestoreTestingPlans