AWS::Backup::RestoreTestingPlan - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Backup::RestoreTestingPlan

Creates a restore testing plan.

The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Backup::RestoreTestingPlan",
  "Properties" : {
      "RecoveryPointSelection" : RestoreTestingRecoveryPointSelection,
      "RestoreTestingPlanName" : String,
      "ScheduleExpression" : String,
      "ScheduleExpressionTimezone" : String,
      "StartWindowHours" : Integer,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Backup::RestoreTestingPlan
Properties:
  RecoveryPointSelection: 
    RestoreTestingRecoveryPointSelection
  RestoreTestingPlanName: String
  ScheduleExpression: String
  ScheduleExpressionTimezone: String
  StartWindowHours: Integer
  Tags: 
    - Tag

Properties

RecoveryPointSelection

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

Required: Yes

Type: RestoreTestingRecoveryPointSelection

Update requires: No interruption

RestoreTestingPlanName

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.

Required: Yes

Type: String

Update requires: Replacement

ScheduleExpression

A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, AWS Backup will use the default expression cron(0 5 ? * * *).

Required: Yes

Type: String

Update requires: No interruption

ScheduleExpressionTimezone

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.

Required: No

Type: String

Update requires: No interruption

StartWindowHours

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).

Required: No

Type: Integer

Update requires: No interruption

Tags

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: + - = . _ : /.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

RestoreTestingPlanArn

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