Interface RestoreTestingPlanForCreate.Builder

All Superinterfaces:
Buildable, CopyableBuilder<RestoreTestingPlanForCreate.Builder,RestoreTestingPlanForCreate>, SdkBuilder<RestoreTestingPlanForCreate.Builder,RestoreTestingPlanForCreate>, SdkPojo
Enclosing class:
RestoreTestingPlanForCreate
@Mutable @NotThreadSafe public static interface RestoreTestingPlanForCreate.Builder extends SdkPojo, CopyableBuilder<RestoreTestingPlanForCreate.Builder,RestoreTestingPlanForCreate>

  • Method Details

    • recoveryPointSelection

      RestoreTestingPlanForCreate.Builder recoveryPointSelection(RestoreTestingRecoveryPointSelection recoveryPointSelection)

      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.

      Parameters:
      recoveryPointSelection - 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:
      Returns a reference to this object so that method calls can be chained together.

    • recoveryPointSelection

      default RestoreTestingPlanForCreate.Builder recoveryPointSelection(Consumer<RestoreTestingRecoveryPointSelection.Builder> recoveryPointSelection)

      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.

      This is a convenience method that creates an instance of the RestoreTestingRecoveryPointSelection.Builder avoiding the need to create one manually via RestoreTestingRecoveryPointSelection.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recoveryPointSelection(RestoreTestingRecoveryPointSelection).

      Parameters:
      recoveryPointSelection - a consumer that will call methods on RestoreTestingRecoveryPointSelection.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • restoreTestingPlanName

      RestoreTestingPlanForCreate.Builder restoreTestingPlanName(String restoreTestingPlanName)

      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.

      Parameters:
      restoreTestingPlanName - 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:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpression

      RestoreTestingPlanForCreate.Builder scheduleExpression(String scheduleExpression)

      A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).

      Parameters:
      scheduleExpression - A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, Backup will use the default expression cron(0 5 ? * * *).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scheduleExpressionTimezone

      RestoreTestingPlanForCreate.Builder scheduleExpressionTimezone(String scheduleExpressionTimezone)

      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.

      Parameters:
      scheduleExpressionTimezone - 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:
      Returns a reference to this object so that method calls can be chained together.

    • startWindowHours

      RestoreTestingPlanForCreate.Builder startWindowHours(Integer startWindowHours)

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

      Parameters:
      startWindowHours - 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:
      Returns a reference to this object so that method calls can be chained together.