Package software.amazon.awssdk.services.arczonalshift.model

Interface ZonalShiftInResource.Builder

    • Method Detail

      • appliedStatus

        ZonalShiftInResource.Builder appliedStatus​(String 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 Route 53 Application Recovery Controller Developer Guide.

        Parameters:
        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 Route 53 Application Recovery Controller Developer Guide.

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

      • appliedStatus

        ZonalShiftInResource.Builder appliedStatus​(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 Route 53 Application Recovery Controller Developer Guide.

        Parameters:
        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 Route 53 Application Recovery Controller Developer Guide.

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

      • awayFrom

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

      • comment

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

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

      • expiryTime

        ZonalShiftInResource.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 Route 53 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 Route 53 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.

      • practiceRunOutcome

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

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

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

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

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

      • practiceRunOutcome

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

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

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

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

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

      • resourceIdentifier

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

        At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

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

        At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

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

      • startTime

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

      • zonalShiftId

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