Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. backup
  5. RestoreTestingPlan

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.backup.RestoreTestingPlan

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Backup::RestoreTestingPlan Resource Type

    Create RestoreTestingPlan Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RestoreTestingPlan(name: string, args: RestoreTestingPlanArgs, opts?: CustomResourceOptions);
    @overload
def RestoreTestingPlan(resource_name: str,
                       args: RestoreTestingPlanArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def RestoreTestingPlan(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       recovery_point_selection: Optional[RestoreTestingPlanRestoreTestingRecoveryPointSelectionArgs] = None,
                       schedule_expression: Optional[str] = None,
                       restore_testing_plan_name: Optional[str] = None,
                       schedule_expression_timezone: Optional[str] = None,
                       schedule_status: Optional[RestoreTestingPlanRestoreTestingScheduleStatus] = None,
                       start_window_hours: Optional[int] = None,
                       tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewRestoreTestingPlan(ctx *Context, name string, args RestoreTestingPlanArgs, opts ...ResourceOption) (*RestoreTestingPlan, error)
    public RestoreTestingPlan(string name, RestoreTestingPlanArgs args, CustomResourceOptions? opts = null)
    public RestoreTestingPlan(String name, RestoreTestingPlanArgs args)
public RestoreTestingPlan(String name, RestoreTestingPlanArgs args, CustomResourceOptions options)

    type: aws-native:backup:RestoreTestingPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RestoreTestingPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RestoreTestingPlanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RestoreTestingPlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RestoreTestingPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RestoreTestingPlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    RestoreTestingPlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RestoreTestingPlan resource accepts the following input properties:

    RecoveryPointSelection Pulumi.AwsNative.Backup.Inputs.RestoreTestingPlanRestoreTestingRecoveryPointSelection
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    ScheduleExpression string
    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 ? * * *) .
    RestoreTestingPlanName string
    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.
    ScheduleExpressionTimezone 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.
    ScheduleStatus Pulumi.AwsNative.Backup.RestoreTestingPlanRestoreTestingScheduleStatus
    This parameter is not currently supported.
    StartWindowHours int

    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 List<Pulumi.AwsNative.Inputs.Tag>
    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: + - = . _ : /.
    RecoveryPointSelection RestoreTestingPlanRestoreTestingRecoveryPointSelectionArgs
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    ScheduleExpression string
    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 ? * * *) .
    RestoreTestingPlanName string
    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.
    ScheduleExpressionTimezone 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.
    ScheduleStatus RestoreTestingPlanRestoreTestingScheduleStatus
    This parameter is not currently supported.
    StartWindowHours int

    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 TagArgs
    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: + - = . _ : /.
    recoveryPointSelection RestoreTestingPlanRestoreTestingRecoveryPointSelection
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    scheduleExpression String
    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 ? * * *) .
    restoreTestingPlanName String
    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.
    scheduleExpressionTimezone 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.
    scheduleStatus RestoreTestingPlanRestoreTestingScheduleStatus
    This parameter is not currently supported.
    startWindowHours Integer

    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 List<Tag>
    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: + - = . _ : /.
    recoveryPointSelection RestoreTestingPlanRestoreTestingRecoveryPointSelection
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    scheduleExpression string
    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 ? * * *) .
    restoreTestingPlanName string
    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.
    scheduleExpressionTimezone 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.
    scheduleStatus RestoreTestingPlanRestoreTestingScheduleStatus
    This parameter is not currently supported.
    startWindowHours number

    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 Tag[]
    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: + - = . _ : /.
    recovery_point_selection RestoreTestingPlanRestoreTestingRecoveryPointSelectionArgs
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    schedule_expression str
    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 ? * * *) .
    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_timezone 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.
    schedule_status RestoreTestingPlanRestoreTestingScheduleStatus
    This parameter is not currently supported.
    start_window_hours int

    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 Sequence[TagArgs]
    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: + - = . _ : /.
    recoveryPointSelection Property Map
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    scheduleExpression String
    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 ? * * *) .
    restoreTestingPlanName String
    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.
    scheduleExpressionTimezone 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.
    scheduleStatus "ACTIVE" | "SUSPENDED"
    This parameter is not currently supported.
    startWindowHours Number

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RestoreTestingPlan resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RestoreTestingPlanArn string
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    Id string
    The provider-assigned unique ID for this managed resource.
    RestoreTestingPlanArn string
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    id String
    The provider-assigned unique ID for this managed resource.
    restoreTestingPlanArn String
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    id string
    The provider-assigned unique ID for this managed resource.
    restoreTestingPlanArn string
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    id str
    The provider-assigned unique ID for this managed resource.
    restore_testing_plan_arn str
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    id String
    The provider-assigned unique ID for this managed resource.
    restoreTestingPlanArn String
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.

    Supporting Types

    RestoreTestingPlanRestoreTestingRecoveryPointSelection, RestoreTestingPlanRestoreTestingRecoveryPointSelectionArgs

    Algorithm Pulumi.AwsNative.Backup.RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithm
    Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
    IncludeVaults List<string>
    Accepted values include wildcard [""] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-", ...]
    RecoveryPointTypes List<Pulumi.AwsNative.Backup.RestoreTestingPlanRestoreTestingRecoveryPointType>

    These are the types of recovery points.

    Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .

    ExcludeVaults List<string>
    Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
    SelectionWindowDays int
    Accepted values are integers from 1 to 365.
    Algorithm RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithm
    Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
    IncludeVaults []string
    Accepted values include wildcard [""] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-", ...]
    RecoveryPointTypes []RestoreTestingPlanRestoreTestingRecoveryPointType

    These are the types of recovery points.

    Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .

    ExcludeVaults []string
    Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
    SelectionWindowDays int
    Accepted values are integers from 1 to 365.
    algorithm RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithm
    Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
    includeVaults List<String>
    Accepted values include wildcard [""] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-", ...]
    recoveryPointTypes List<RestoreTestingPlanRestoreTestingRecoveryPointType>

    These are the types of recovery points.

    Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .

    excludeVaults List<String>
    Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
    selectionWindowDays Integer
    Accepted values are integers from 1 to 365.
    algorithm RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithm
    Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
    includeVaults string[]
    Accepted values include wildcard [""] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-", ...]
    recoveryPointTypes RestoreTestingPlanRestoreTestingRecoveryPointType[]

    These are the types of recovery points.

    Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .

    excludeVaults string[]
    Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
    selectionWindowDays number
    Accepted values are integers from 1 to 365.
    algorithm RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithm
    Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
    include_vaults Sequence[str]
    Accepted values include wildcard [""] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-", ...]
    recovery_point_types Sequence[RestoreTestingPlanRestoreTestingRecoveryPointType]

    These are the types of recovery points.

    Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .

    exclude_vaults Sequence[str]
    Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
    selection_window_days int
    Accepted values are integers from 1 to 365.
    algorithm "LATEST_WITHIN_WINDOW" | "RANDOM_WITHIN_WINDOW"
    Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
    includeVaults List<String>
    Accepted values include wildcard [""] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:::backup-vault:asdf-", ...]
    recoveryPointTypes List<"SNAPSHOT" | "CONTINUOUS">

    These are the types of recovery points.

    Include SNAPSHOT to restore only snapshot recovery points; include CONTINUOUS to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for Algorithm .

    excludeVaults List<String>
    Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
    selectionWindowDays Number
    Accepted values are integers from 1 to 365.

    RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithm, RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithmArgs

    LatestWithinWindow
    LATEST_WITHIN_WINDOW
    RandomWithinWindow
    RANDOM_WITHIN_WINDOW
    RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithmLatestWithinWindow
    LATEST_WITHIN_WINDOW
    RestoreTestingPlanRestoreTestingRecoveryPointSelectionAlgorithmRandomWithinWindow
    RANDOM_WITHIN_WINDOW
    LatestWithinWindow
    LATEST_WITHIN_WINDOW
    RandomWithinWindow
    RANDOM_WITHIN_WINDOW
    LatestWithinWindow
    LATEST_WITHIN_WINDOW
    RandomWithinWindow
    RANDOM_WITHIN_WINDOW
    LATEST_WITHIN_WINDOW
    LATEST_WITHIN_WINDOW
    RANDOM_WITHIN_WINDOW
    RANDOM_WITHIN_WINDOW
    "LATEST_WITHIN_WINDOW"
    LATEST_WITHIN_WINDOW
    "RANDOM_WITHIN_WINDOW"
    RANDOM_WITHIN_WINDOW

    RestoreTestingPlanRestoreTestingRecoveryPointType, RestoreTestingPlanRestoreTestingRecoveryPointTypeArgs

    Snapshot
    SNAPSHOT
    Continuous
    CONTINUOUS
    RestoreTestingPlanRestoreTestingRecoveryPointTypeSnapshot
    SNAPSHOT
    RestoreTestingPlanRestoreTestingRecoveryPointTypeContinuous
    CONTINUOUS
    Snapshot
    SNAPSHOT
    Continuous
    CONTINUOUS
    Snapshot
    SNAPSHOT
    Continuous
    CONTINUOUS
    SNAPSHOT
    SNAPSHOT
    CONTINUOUS
    CONTINUOUS
    "SNAPSHOT"
    SNAPSHOT
    "CONTINUOUS"
    CONTINUOUS

    RestoreTestingPlanRestoreTestingScheduleStatus, RestoreTestingPlanRestoreTestingScheduleStatusArgs

    Active
    ACTIVE
    Suspended
    SUSPENDED
    RestoreTestingPlanRestoreTestingScheduleStatusActive
    ACTIVE
    RestoreTestingPlanRestoreTestingScheduleStatusSuspended
    SUSPENDED
    Active
    ACTIVE
    Suspended
    SUSPENDED
    Active
    ACTIVE
    Suspended
    SUSPENDED
    ACTIVE
    ACTIVE
    SUSPENDED
    SUSPENDED
    "ACTIVE"
    ACTIVE
    "SUSPENDED"
    SUSPENDED

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native