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

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

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

    Using getRestoreTestingPlan

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRestoreTestingPlan(args: GetRestoreTestingPlanArgs, opts?: InvokeOptions): Promise<GetRestoreTestingPlanResult>
function getRestoreTestingPlanOutput(args: GetRestoreTestingPlanOutputArgs, opts?: InvokeOptions): Output<GetRestoreTestingPlanResult>
    def get_restore_testing_plan(restore_testing_plan_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetRestoreTestingPlanResult
def get_restore_testing_plan_output(restore_testing_plan_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetRestoreTestingPlanResult]
    func LookupRestoreTestingPlan(ctx *Context, args *LookupRestoreTestingPlanArgs, opts ...InvokeOption) (*LookupRestoreTestingPlanResult, error)
func LookupRestoreTestingPlanOutput(ctx *Context, args *LookupRestoreTestingPlanOutputArgs, opts ...InvokeOption) LookupRestoreTestingPlanResultOutput

    > Note: This function is named LookupRestoreTestingPlan in the Go SDK.

    public static class GetRestoreTestingPlan 
{
    public static Task<GetRestoreTestingPlanResult> InvokeAsync(GetRestoreTestingPlanArgs args, InvokeOptions? opts = null)
    public static Output<GetRestoreTestingPlanResult> Invoke(GetRestoreTestingPlanInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRestoreTestingPlanResult> getRestoreTestingPlan(GetRestoreTestingPlanArgs args, InvokeOptions options)
public static Output<GetRestoreTestingPlanResult> getRestoreTestingPlan(GetRestoreTestingPlanArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:backup:getRestoreTestingPlan
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getRestoreTestingPlan Result

    The following output properties are available:

    RecoveryPointSelection Pulumi.AwsNative.Backup.Outputs.RestoreTestingPlanRestoreTestingRecoveryPointSelection
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    RestoreTestingPlanArn string
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    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 ? * * *) .
    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.Outputs.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.
    RestoreTestingPlanArn string
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    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 ? * * *) .
    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 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.
    restoreTestingPlanArn String
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    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 ? * * *) .
    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.
    restoreTestingPlanArn string
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    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 ? * * *) .
    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 RestoreTestingPlanRestoreTestingRecoveryPointSelection
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    restore_testing_plan_arn str
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    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 ? * * *) .
    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[root_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 Property Map
    The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
    restoreTestingPlanArn String
    An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
    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 ? * * *) .
    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: + - = . _ : /.

    Supporting Types

    RestoreTestingPlanRestoreTestingRecoveryPointSelection

    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

    RestoreTestingPlanRestoreTestingRecoveryPointType

    RestoreTestingPlanRestoreTestingScheduleStatus

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