Class ZonalShiftInResource

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

A complex structure that lists the zonal shifts for a managed resource and their statuses for the resource.

See Also:

  • Method Details

    • appliedStatus

      public final AppliedStatus appliedStatus()

      The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.

      The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.

      For more information, see How zonal autoshift and practice runs work in the Amazon Application Recovery Controller Developer Guide.

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

      Returns:
      The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.

      The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.

      For more information, see How zonal autoshift and practice runs work in the Amazon Application Recovery Controller Developer Guide.

      See Also:

    • appliedStatusAsString

      public final String appliedStatusAsString()

      The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.

      The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.

      For more information, see How zonal autoshift and practice runs work in the Amazon Application Recovery Controller Developer Guide.

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

      Returns:
      The appliedStatus field specifies which application traffic shift is in effect for a resource when there is more than one active traffic shift. There can be more than one application traffic shift in progress at the same time - that is, practice run zonal shifts, customer-initiated zonal shifts, or an autoshift. The appliedStatus field for a shift that is in progress for a resource can have one of two values: APPLIED or NOT_APPLIED. The zonal shift or autoshift that is currently in effect for the resource has an appliedStatus set to APPLIED.

      The overall principle for precedence is that zonal shifts that you start as a customer take precedence autoshifts, which take precedence over practice runs. That is, customer-initiated zonal shifts > autoshifts > practice run zonal shifts.

      For more information, see How zonal autoshift and practice runs work in the Amazon Application Recovery Controller Developer Guide.

      See Also:

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

    • comment

      public final String comment()

      A comment that you enter for a customer-initiated 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 for a customer-initiated 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, returned for a practice run. The following values can be returned:

      • PENDING: Outcome value when a 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 the expected 30 minute zonal shift.

      • INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, 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, returned for a practice run. The following values can be returned:

      • PENDING: Outcome value when a 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 the expected 30 minute zonal shift.

      • INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, 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, returned for a practice run. The following values can be returned:

      • PENDING: Outcome value when a 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 the expected 30 minute zonal shift.

      • INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, 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, returned for a practice run. The following values can be returned:

      • PENDING: Outcome value when a 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 the expected 30 minute zonal shift.

      • INTERRUPTED: Outcome value when the practice run was stopped before the expected 30 minute zonal shift duration, 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 ZonalShiftInResource.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<ZonalShiftInResource.Builder,ZonalShiftInResource>
      Returns:
      a builder for type T

    • builder

      public static ZonalShiftInResource.Builder builder()

    • serializableBuilderClass

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