Interface ICfnRestoreTestingPlanProps

Properties for defining a CfnRestoreTestingPlan.

Namespace: Amazon.CDK.AWS.Backup

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnRestoreTestingPlanProps

Syntax (vb)

Public Interface ICfnRestoreTestingPlanProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Backup;

             var cfnRestoreTestingPlanProps = new CfnRestoreTestingPlanProps {
                 RecoveryPointSelection = new RestoreTestingRecoveryPointSelectionProperty {
                     Algorithm = "algorithm",
                     IncludeVaults = new [] { "includeVaults" },
                     RecoveryPointTypes = new [] { "recoveryPointTypes" },

                     // the properties below are optional
                     ExcludeVaults = new [] { "excludeVaults" },
                     SelectionWindowDays = 123
                 },
                 RestoreTestingPlanName = "restoreTestingPlanName",
                 ScheduleExpression = "scheduleExpression",

                 // the properties below are optional
                 ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                 StartWindowHours = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

RecoveryPointSelection	The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
RestoreTestingPlanName	The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.
ScheduleExpression	A CRON expression in specified timezone when a restore testing plan is executed.
ScheduleExpressionTimezone	Optional.
StartWindowHours	Defaults to 24 hours.
Tags	Optional tags to include.

Properties

RecoveryPointSelection

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

object RecoveryPointSelection { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnRestoreTestingPlan.IRestoreTestingRecoveryPointSelectionProperty

RestoreTestingPlanName

The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.

string RestoreTestingPlanName { get; }

Property Value

string

Remarks

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

ScheduleExpression

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

string ScheduleExpression { get; }

Property Value

string

Remarks

When no CRON expression is provided, AWS Backup will use the default expression cron(0 5 ? * * *) .

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

ScheduleExpressionTimezone

Optional.

string? ScheduleExpressionTimezone { get; }

Property Value

string

Remarks

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

StartWindowHours

Defaults to 24 hours.

double? StartWindowHours { get; }

Property Value

double?

Remarks

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