Class ZonalShiftSummary

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

Lists information about zonal shifts in Amazon Application Recovery Controller, including zonal shifts that you start yourself and zonal shifts that ARC starts on your behalf for practice runs with zonal autoshift.

Zonal shifts are temporary, including customer-initiated zonal shifts and the zonal autoshift practice run zonal shifts that ARC starts weekly, on your behalf. A zonal shift that a customer starts can be active for up to three days (72 hours). A practice run zonal shift has a 30 minute duration.

See Also:

  • Method Details

    • zonalShiftId

      public final String zonalShiftId()

      The identifier of a zonal shift.

      Returns:
      The identifier of a zonal shift.

    • resourceIdentifier

      public final String resourceIdentifier()

      The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

      Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:

      Returns:
      The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.

      Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:

    • awayFrom

      public final String awayFrom()

      The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.

      Returns:
      The Availability Zone (for example, use1-az1) that traffic is moved away from for a resource when you start a zonal shift. Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the Amazon Web Services Region.

    • expiryTime

      public final Instant expiryTime()

      The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.

      When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.

      Returns:
      The expiry time (expiration time) for a customer-initiated zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift. You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift to set a new expiration at any time.

      When you start a zonal shift, you specify how long you want it to be active, which ARC converts to an expiry time (expiration time). You can cancel a zonal shift when you're ready to restore traffic to the Availability Zone, or just wait for it to expire. Or you can update the zonal shift to specify another length of time to expire in.

    • startTime

      public final Instant startTime()

      The time (UTC) when the zonal shift starts.

      Returns:
      The time (UTC) when the zonal shift starts.

    • status

      public final ZonalShiftStatus status()

      A status for a zonal shift.

      The Status for a zonal shift can have one of the following values:

      • ACTIVE: The zonal shift has been started and is active.

      • EXPIRED: The zonal shift has expired (the expiry time was exceeded).

      • CANCELED: The zonal shift was canceled.

      If the service returns an enum value that is not available in the current SDK version, status will return ZonalShiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      A status for a zonal shift.

      The Status for a zonal shift can have one of the following values:

      • ACTIVE: The zonal shift has been started and is active.

      • EXPIRED: The zonal shift has expired (the expiry time was exceeded).

      • CANCELED: The zonal shift was canceled.

      See Also:

    • statusAsString

      public final String statusAsString()

      A status for a zonal shift.

      The Status for a zonal shift can have one of the following values:

      • ACTIVE: The zonal shift has been started and is active.

      • EXPIRED: The zonal shift has expired (the expiry time was exceeded).

      • CANCELED: The zonal shift was canceled.

      If the service returns an enum value that is not available in the current SDK version, status will return ZonalShiftStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      A status for a zonal shift.

      The Status for a zonal shift can have one of the following values:

      • ACTIVE: The zonal shift has been started and is active.

      • EXPIRED: The zonal shift has expired (the expiry time was exceeded).

      • CANCELED: The zonal shift was canceled.

      See Also:

    • comment

      public final String comment()

      A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.

      Returns:
      A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. That is, a new comment overwrites any existing comment string.

    • shiftType

      public final ShiftType shiftType()

      Defines the zonal shift type.

      If the service returns an enum value that is not available in the current SDK version, shiftType will return ShiftType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shiftTypeAsString().

      Returns:
      Defines the zonal shift type.
      See Also:

    • shiftTypeAsString

      public final String shiftTypeAsString()

      Defines the zonal shift type.

      If the service returns an enum value that is not available in the current SDK version, shiftType will return ShiftType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from shiftTypeAsString().

      Returns:
      Defines the zonal shift type.
      See Also:

    • practiceRunOutcome

      public final PracticeRunOutcome practiceRunOutcome()

      The outcome, or end state, of a practice run. The following values can be returned:

      • PENDING: Outcome value when the practice run is in progress.

      • SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

      • INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.

      • FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

      • CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.

      For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

      If the service returns an enum value that is not available in the current SDK version, practiceRunOutcome will return PracticeRunOutcome.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from practiceRunOutcomeAsString().

      Returns:
      The outcome, or end state, of a practice run. The following values can be returned:

      • PENDING: Outcome value when the practice run is in progress.

      • SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

      • INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.

      • FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

      • CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.

      For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

      See Also:

    • practiceRunOutcomeAsString

      public final String practiceRunOutcomeAsString()

      The outcome, or end state, of a practice run. The following values can be returned:

      • PENDING: Outcome value when the practice run is in progress.

      • SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

      • INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.

      • FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

      • CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.

      For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

      If the service returns an enum value that is not available in the current SDK version, practiceRunOutcome will return PracticeRunOutcome.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from practiceRunOutcomeAsString().

      Returns:
      The outcome, or end state, of a practice run. The following values can be returned:

      • PENDING: Outcome value when the practice run is in progress.

      • SUCCEEDED: Outcome value when the outcome alarm specified for the practice run configuration does not go into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

      • INTERRUPTED: Outcome value when the practice run did not run for the expected 30 minutes or there was another problem with the practice run that created an inconclusive outcome.

      • FAILED: Outcome value when the outcome alarm specified for the practice run configuration goes into an ALARM state during the practice run, and the practice run was not interrupted before it completed.

      • CAPACITY_CHECK_FAILED: The check for balanced capacity across Availability Zones for your load balancing and Auto Scaling group resources failed.

      For more information about practice run outcomes, see Considerations when you configure zonal autoshift in the Amazon Application Recovery Controller Developer Guide.

      See Also:

    • toBuilder

      public ZonalShiftSummary.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<ZonalShiftSummary.Builder,ZonalShiftSummary>
      Returns:
      a builder for type T

    • builder

      public static ZonalShiftSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ZonalShiftSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.