CfnRestoreTestingPlanProps

class aws_cdk.aws_backup.CfnRestoreTestingPlanProps(*, recovery_point_selection, restore_testing_plan_name, schedule_expression, schedule_expression_timezone=None, start_window_hours=None, tags=None)

Bases: object

Properties for defining a CfnRestoreTestingPlan.

Parameters:
  • recovery_point_selection (Union[IResolvable, RestoreTestingRecoveryPointSelectionProperty, Dict[str, Any]]) – The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

  • restore_testing_plan_name (str) – 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.

  • schedule_expression (str) – A CRON expression in specified timezone when a restore testing plan is executed.

  • schedule_expression_timezone (Optional[str]) – 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.

  • start_window_hours (Union[int, float, None]) – 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).

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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: + - = . _ : /.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_backup as backup

cfn_restore_testing_plan_props = backup.CfnRestoreTestingPlanProps(
    recovery_point_selection=backup.CfnRestoreTestingPlan.RestoreTestingRecoveryPointSelectionProperty(
        algorithm="algorithm",
        include_vaults=["includeVaults"],
        recovery_point_types=["recoveryPointTypes"],

        # the properties below are optional
        exclude_vaults=["excludeVaults"],
        selection_window_days=123
    ),
    restore_testing_plan_name="restoreTestingPlanName",
    schedule_expression="scheduleExpression",

    # the properties below are optional
    schedule_expression_timezone="scheduleExpressionTimezone",
    start_window_hours=123,
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

recovery_point_selection

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-recoverypointselection

restore_testing_plan_name

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-restoretestingplanname

schedule_expression

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-scheduleexpression

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-scheduleexpressiontimezone

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-startwindowhours

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: + - = . _ : /.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-tags