Skip to content

aws.backup.get_restore_testing_plan

Example SQL Queries

SELECT * FROM
aws.backup.get_restore_testing_plan
WHERE
"restore_testing_plan_name" = 'VALUE';

Description

Returns RestoreTestingPlan details for the specified RestoreTestingPlanName. The details are the body of a restore testing plan in JSON format, in addition to plan metadata.

Table Definition

Column NameColumn Data Type
restore_testing_plan_name Required Input Column

Required unique name of the restore testing plan.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
restore_testing_plan

Specifies the body of a restore testing plan. Includes RestoreTestingPlanName.

STRUCT(
"creation_time" TIMESTAMP_S,
"creator_request_id" VARCHAR,
"last_execution_time" TIMESTAMP_S,
"last_update_time" TIMESTAMP_S,
"recovery_point_selection" STRUCT(
"algorithm" VARCHAR,
"exclude_vaults" VARCHAR[],
"include_vaults" VARCHAR[],
"recovery_point_types" VARCHAR[],
"selection_window_days" BIGINT
),
"restore_testing_plan_arn" VARCHAR,
"restore_testing_plan_name" VARCHAR,
"schedule_expression" VARCHAR,
"schedule_expression_timezone" VARCHAR,
"start_window_hours" BIGINT
)
Show child fields
restore_testing_plan.creation_time

The date and time that a restore testing plan was created, in Unix format and Coordinated Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

restore_testing_plan.creator_request_id

This identifies the request and allows failed requests to be retried without the risk of running the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.

restore_testing_plan.last_execution_time

The last time a restore test was run with the specified restore testing plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

restore_testing_plan.last_update_time

The date and time that the restore testing plan was updated. This update is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

restore_testing_plan.recovery_point_selection

The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

Show child fields
restore_testing_plan.recovery_point_selection.algorithm

Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"

restore_testing_plan.recovery_point_selection.exclude_vaults[]
restore_testing_plan.recovery_point_selection.include_vaults[]
restore_testing_plan.recovery_point_selection.recovery_point_types[]
restore_testing_plan.recovery_point_selection.selection_window_days

Accepted values are integers from 1 to 365.

restore_testing_plan.restore_testing_plan_arn

An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

restore_testing_plan.restore_testing_plan_name

This is the restore testing plan name.

restore_testing_plan.schedule_expression

A CRON expression in specified timezone when a restore testing plan is executed.

restore_testing_plan.schedule_expression_timezone

Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.

restore_testing_plan.start_window_hours

Defaults to 24 hours.

A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).