Package software.amazon.awscdk.services.backup

Class CfnRestoreTestingPlan

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.backup.CfnRestoreTestingPlan
All Implemented Interfaces:
IInspectable, IRestoreTestingPlanRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:09:59.472Z") @Stability(Stable) public class CfnRestoreTestingPlan extends CfnResource implements IInspectable, IRestoreTestingPlanRef, ITaggableV2
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.

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.*;
 CfnRestoreTestingPlan cfnRestoreTestingPlan = CfnRestoreTestingPlan.Builder.create(this, "MyCfnRestoreTestingPlan")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRestoreTestingPlan

      protected CfnRestoreTestingPlan(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRestoreTestingPlan

      protected CfnRestoreTestingPlan(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRestoreTestingPlan

      @Stability(Stable) public CfnRestoreTestingPlan(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRestoreTestingPlanProps props)
      Create a new AWS::Backup::RestoreTestingPlan.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrRestoreTestingPlanArn

      @Stability(Stable) @NotNull public String getAttrRestoreTestingPlanArn()
      An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRestoreTestingPlanRef

      @Stability(Stable) @NotNull public RestoreTestingPlanReference getRestoreTestingPlanRef()
      A reference to a RestoreTestingPlan resource.
      Specified by:
      getRestoreTestingPlanRef in interface IRestoreTestingPlanRef

    • getRecoveryPointSelection

      @Stability(Stable) @NotNull public Object getRecoveryPointSelection()
      The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

      Returns union: either IResolvable or CfnRestoreTestingPlan.RestoreTestingRecoveryPointSelectionProperty

    • setRecoveryPointSelection

      @Stability(Stable) public void setRecoveryPointSelection(@NotNull IResolvable value)
      The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

    • setRecoveryPointSelection

      @Stability(Stable) public void setRecoveryPointSelection(@NotNull CfnRestoreTestingPlan.RestoreTestingRecoveryPointSelectionProperty value)
      The specified criteria to assign a set of resources, such as recovery point types or backup vaults.

    • getRestoreTestingPlanName

      @Stability(Stable) @NotNull public String getRestoreTestingPlanName()
      The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.

    • setRestoreTestingPlanName

      @Stability(Stable) public void setRestoreTestingPlanName(@NotNull String value)
      The RestoreTestingPlanName is a unique string that is the name of the restore testing plan.

    • getScheduleExpression

      @Stability(Stable) @NotNull public String getScheduleExpression()
      A CRON expression in specified timezone when a restore testing plan is executed.

    • setScheduleExpression

      @Stability(Stable) public void setScheduleExpression(@NotNull String value)
      A CRON expression in specified timezone when a restore testing plan is executed.

    • getScheduleExpressionTimezone

      @Stability(Stable) @Nullable public String getScheduleExpressionTimezone()
      Optional.

    • setScheduleExpressionTimezone

      @Stability(Stable) public void setScheduleExpressionTimezone(@Nullable String value)
      Optional.

    • getStartWindowHours

      @Stability(Stable) @Nullable public Number getStartWindowHours()
      Defaults to 24 hours.

    • setStartWindowHours

      @Stability(Stable) public void setStartWindowHours(@Nullable Number value)
      Defaults to 24 hours.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Optional tags to include.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Optional tags to include.