Class RestoreTestingPlanForCreate

java.lang.Object
software.amazon.awssdk.services.backup.model.RestoreTestingPlanForCreate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RestoreTestingPlanForCreate.Builder,RestoreTestingPlanForCreate>
@Generated("software.amazon.awssdk:codegen") public final class RestoreTestingPlanForCreate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RestoreTestingPlanForCreate.Builder,RestoreTestingPlanForCreate>

This contains metadata about a restore testing plan.

See Also:

  • Method Details

    • recoveryPointSelection

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

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

    • restoreTestingPlanName

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

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

    • scheduleExpression

      public final String scheduleExpression()

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

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

    • scheduleExpressionTimezone

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

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

    • startWindowHours

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

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

    • toBuilder

      public RestoreTestingPlanForCreate.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RestoreTestingPlanForCreate.Builder,RestoreTestingPlanForCreate>
      Returns:
      a builder for type T

    • builder

      public static RestoreTestingPlanForCreate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RestoreTestingPlanForCreate.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.