restore_testing_selections

Creates, updates, deletes or gets a restore_testing_selection resource or lists restore_testing_selections in a region

Overview

Name	restore_testing_selections
Type	Resource
Description	Resource Type definition for AWS::Backup::RestoreTestingSelection
Id	awscc.backup.restore_testing_selections

Fields

get (all properties)

Name	Datatype	Description
iam_role_arn	string
protected_resource_arns	array
▶protected_resource_conditions	object
protected_resource_type	string
restore_metadata_overrides	object
restore_testing_plan_name	string
restore_testing_selection_name	string
validation_window_hours	integer
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
restore_testing_plan_name	string
restore_testing_selection_name	string
region	string	AWS region.

For more information, see AWS::Backup::RestoreTestingSelection.

Methods

Name	Resource	Accessible by	Required Params
create_resource	restore_testing_selections	INSERT	IamRoleArn, ProtectedResourceType, RestoreTestingPlanName, RestoreTestingSelectionName, region
delete_resource	restore_testing_selections	DELETE	Identifier, region
update_resource	restore_testing_selections	UPDATE	Identifier, PatchDocument, region
list_resources	restore_testing_selections_list_only	SELECT	region
get_resource	restore_testing_selections	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual restore_testing_selection.

SELECT
  region,
  iam_role_arn,
  protected_resource_arns,
  protected_resource_conditions,
  protected_resource_type,
  restore_metadata_overrides,
  restore_testing_plan_name,
  restore_testing_selection_name,
  validation_window_hours
FROM awscc.backup.restore_testing_selections
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ restore_testing_plan_name }}|{{ restore_testing_selection_name }}';

list (identifiers only)

Lists all restore_testing_selections in a region.

SELECT
  region,
  restore_testing_plan_name,
  restore_testing_selection_name
FROM awscc.backup.restore_testing_selections_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.backup.restore_testing_selections (
  IamRoleArn,
  ProtectedResourceType,
  RestoreTestingPlanName,
  RestoreTestingSelectionName,
  region
)
SELECT
  '{{ iam_role_arn }}',
  '{{ protected_resource_type }}',
  '{{ restore_testing_plan_name }}',
  '{{ restore_testing_selection_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.backup.restore_testing_selections (
  IamRoleArn,
  ProtectedResourceArns,
  ProtectedResourceConditions,
  ProtectedResourceType,
  RestoreMetadataOverrides,
  RestoreTestingPlanName,
  RestoreTestingSelectionName,
  ValidationWindowHours,
  region
)
SELECT
  '{{ iam_role_arn }}',
  '{{ protected_resource_arns }}',
  '{{ protected_resource_conditions }}',
  '{{ protected_resource_type }}',
  '{{ restore_metadata_overrides }}',
  '{{ restore_testing_plan_name }}',
  '{{ restore_testing_selection_name }}',
  '{{ validation_window_hours }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: restore_testing_selection
  props:
    - name: iam_role_arn
      value: '{{ iam_role_arn }}'
    - name: protected_resource_arns
      value:
        - '{{ protected_resource_arns[0] }}'
    - name: protected_resource_conditions
      value:
        string_equals:
          - key: '{{ key }}'
            value: '{{ value }}'
        string_not_equals:
          - null
    - name: protected_resource_type
      value: '{{ protected_resource_type }}'
    - name: restore_metadata_overrides
      value: {}
    - name: restore_testing_plan_name
      value: '{{ restore_testing_plan_name }}'
    - name: restore_testing_selection_name
      value: '{{ restore_testing_selection_name }}'
    - name: validation_window_hours
      value: '{{ validation_window_hours }}'

UPDATE example

Use the following StackQL query and manifest file to update a restore_testing_selection resource, using stack-deploy.

/*+ update */
UPDATE awscc.backup.restore_testing_selections
SET PatchDocument = string('{{ {
    "IamRoleArn": iam_role_arn,
    "ProtectedResourceArns": protected_resource_arns,
    "ProtectedResourceConditions": protected_resource_conditions,
    "RestoreMetadataOverrides": restore_metadata_overrides,
    "ValidationWindowHours": validation_window_hours
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ restore_testing_plan_name }}|{{ restore_testing_selection_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.backup.restore_testing_selections
WHERE
  Identifier = '{{ restore_testing_plan_name }}|{{ restore_testing_selection_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

backup:CreateRestoreTestingSelection,
backup:GetRestoreTestingSelection,
iam:PassRole

Read

backup:GetRestoreTestingSelection

Update

backup:UpdateRestoreTestingSelection,
backup:GetRestoreTestingSelection,
iam:PassRole

Delete

backup:DeleteRestoreTestingSelection,
backup:GetRestoreTestingSelection

List

backup:ListRestoreTestingSelections,
backup:ListRestoreTestingPlans