Interface ZonalShiftSummary.Builder

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

  • Method Details

    • zonalShiftId

      ZonalShiftSummary.Builder zonalShiftId(String zonalShiftId)

      The identifier of a zonal shift.

      Parameters:
      zonalShiftId - The identifier of a zonal shift.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resourceIdentifier

      ZonalShiftSummary.Builder resourceIdentifier(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:

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

    • awayFrom

      ZonalShiftSummary.Builder awayFrom(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.

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

    • expiryTime

      ZonalShiftSummary.Builder expiryTime(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.

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

    • startTime

      ZonalShiftSummary.Builder startTime(Instant startTime)

      The time (UTC) when the zonal shift starts.

      Parameters:
      startTime - The time (UTC) when the zonal shift starts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ZonalShiftSummary.Builder status(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ZonalShiftSummary.Builder status(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • comment

      ZonalShiftSummary.Builder comment(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.

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

    • shiftType

      ZonalShiftSummary.Builder shiftType(String shiftType)

      Defines the zonal shift type.

      Parameters:
      shiftType - Defines the zonal shift type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • shiftType

      ZonalShiftSummary.Builder shiftType(ShiftType shiftType)

      Defines the zonal shift type.

      Parameters:
      shiftType - Defines the zonal shift type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • practiceRunOutcome

      ZonalShiftSummary.Builder practiceRunOutcome(String 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • practiceRunOutcome

      ZonalShiftSummary.Builder practiceRunOutcome(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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: