AWS CDK Reference

Appearance

v2.275.0

CfnRestoreTestingPlanProps Struct ​

Properties for defining a CfnRestoreTestingPlan.

Source
Generated code
Type last changed
v2.190.0 · 17 Apr 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_backup as backup } from 'aws-cdk-lib';
const cfnRestoreTestingPlanProps: backup.CfnRestoreTestingPlanProps = {
  recoveryPointSelection: {
    algorithm: 'algorithm',
    includeVaults: ['includeVaults'],
    recoveryPointTypes: ['recoveryPointTypes'],

    // the properties below are optional
    excludeVaults: ['excludeVaults'],
    selectionWindowDays: 123,
  },
  restoreTestingPlanName: 'restoreTestingPlanName',
  scheduleExpression: 'scheduleExpression',

  // the properties below are optional
  scheduleExpressionTimezone: 'scheduleExpressionTimezone',
  startWindowHours: 123,
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

recoveryPointSelectionIResolvable | CfnRestoreTestingPlan.RestoreTestingRecoveryPointSelectionPropertyrecovery_point_selectiontyping.Union[IResolvable, RestoreTestingRecoveryPointSelectionProperty]recoveryPointSelectionIResolvableRecoveryPointSelectionIResolvableRecoveryPointSelectioninterface{}required#
The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
restoreTestingPlanNamestringrestore_testing_plan_namestrrestoreTestingPlanNameStringRestoreTestingPlanNamestringRestoreTestingPlanName*stringrequired#
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.

scheduleExpressionstringschedule_expressionstrscheduleExpressionStringScheduleExpressionstringScheduleExpression*stringrequired#
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 ? * * *) .

scheduleExpressionTimezoneoptionalstringschedule_expression_timezoneoptionalstrscheduleExpressionTimezoneoptionalStringScheduleExpressionTimezoneoptionalstringScheduleExpressionTimezoneoptional*string#
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.

startWindowHoursoptionalnumberstart_window_hoursoptionalint | floatstartWindowHoursoptionalNumberStartWindowHoursoptionaldoubleStartWindowHoursoptional*float64#
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).

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
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: + - = . _ : /.