Class: Aws::Backup::Types::RestoreTestingPlanForCreate

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::RestoreTestingPlanForCreate

Defined in:

gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

This contains metadata about a restore testing plan.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #recovery_point_selection ⇒ Types::RestoreTestingRecoveryPointSelection

  RecoveryPointSelection has five parameters (three required and two optional).

• #restore_testing_plan_name ⇒ String

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

• #schedule_expression ⇒ String

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

• #schedule_expression_timezone ⇒ String

  Optional.

• #start_window_hours ⇒ Integer

  Defaults to 24 hours.

Instance Attribute Details

#recovery_point_selection ⇒ Types::RestoreTestingRecoveryPointSelection

RecoveryPointSelection has five parameters (three required and two optional). The values you specify determine which recovery point is included in the restore test. You must indicate with Algorithm if you want the latest recovery point within your SelectionWindowDays or if you want a random recovery point, and you must indicate through IncludeVaults from which vaults the recovery points can be chosen.

Algorithm (required) Valid values: "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW".

Recovery point types (required) Valid values: "SNAPSHOT" and/or "CONTINUOUS". 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.

IncludeVaults (required). You must include one or more backup vaults. Use the wildcard ["*"] or specific ARNs.

SelectionWindowDays (optional) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to 30.

ExcludeVaults (optional). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.

Returns:

• (Types::RestoreTestingRecoveryPointSelection)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7715

class RestoreTestingPlanForCreate < Struct.new(
  :recovery_point_selection,
  :restore_testing_plan_name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_window_hours)
  SENSITIVE = []
  include Aws::Structure
end

#restore_testing_plan_name ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7715

class RestoreTestingPlanForCreate < Struct.new(
  :recovery_point_selection,
  :restore_testing_plan_name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_window_hours)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7715

class RestoreTestingPlanForCreate < Struct.new(
  :recovery_point_selection,
  :restore_testing_plan_name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_window_hours)
  SENSITIVE = []
  include Aws::Structure
end

#schedule_expression_timezone ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7715

class RestoreTestingPlanForCreate < Struct.new(
  :recovery_point_selection,
  :restore_testing_plan_name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_window_hours)
  SENSITIVE = []
  include Aws::Structure
end

#start_window_hours ⇒ 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).

Returns:

• (Integer)

# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 7715

class RestoreTestingPlanForCreate < Struct.new(
  :recovery_point_selection,
  :restore_testing_plan_name,
  :schedule_expression,
  :schedule_expression_timezone,
  :start_window_hours)
  SENSITIVE = []
  include Aws::Structure
end