Package software.amazon.awscdk.services.backup

Interface CfnRestoreTestingPlanProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRestoreTestingPlanProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:11.772Z")
@Stability(Stable)
public interface CfnRestoreTestingPlanProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnRestoreTestingPlan.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.backup.*;
 CfnRestoreTestingPlanProps cfnRestoreTestingPlanProps = CfnRestoreTestingPlanProps.builder()
         .recoveryPointSelection(RestoreTestingRecoveryPointSelectionProperty.builder()
                 .algorithm("algorithm")
                 .includeVaults(List.of("includeVaults"))
                 .recoveryPointTypes(List.of("recoveryPointTypes"))
                 // the properties below are optional
                 .excludeVaults(List.of("excludeVaults"))
                 .selectionWindowDays(123)
                 .build())
         .restoreTestingPlanName("restoreTestingPlanName")
         .scheduleExpression("scheduleExpression")
         // the properties below are optional
         .scheduleExpressionTimezone("scheduleExpressionTimezone")
         .startWindowHours(123)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRestoreTestingPlanProps.Builder	A builder for CfnRestoreTestingPlanProps
static final class	CfnRestoreTestingPlanProps.Jsii$Proxy	An implementation for CfnRestoreTestingPlanProps

Method Summary

Modifier and Type	Method	Description
static CfnRestoreTestingPlanProps.Builder	builder()
Object	getRecoveryPointSelection()	The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
String	getRestoreTestingPlanName()	The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.
String	getScheduleExpression()	A CRON expression in specified timezone when a restore testing plan is executed.
default String	getScheduleExpressionTimezone()	Optional.
default Number	getStartWindowHours()	Defaults to 24 hours.
default List<CfnTag>	getTags()	Optional tags to include.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRecoveryPointSelection

@Stability(Stable)
@NotNull
Object getRecoveryPointSelection()

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

See Also:

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

getRestoreTestingPlanName

@Stability(Stable)
@NotNull
String getRestoreTestingPlanName()

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 Also:

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

getScheduleExpression

@Stability(Stable)
@NotNull
String getScheduleExpression()

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

See Also:

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

getScheduleExpressionTimezone

@Stability(Stable)
@Nullable
default String getScheduleExpressionTimezone()

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 Also:

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

getStartWindowHours

@Stability(Stable)
@Nullable
default Number getStartWindowHours()

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 Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

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

builder

@Stability(Stable)
static CfnRestoreTestingPlanProps.Builder builder()

Returns:

a CfnRestoreTestingPlanProps.Builder of CfnRestoreTestingPlanProps