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

Interface StartZonalShiftRequest.Builder

    • Method Detail

      • awayFrom

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

        StartZonalShiftRequest.Builder comment​(String comment)

        A comment that you enter about the zonal shift. Only the latest comment is retained; no comment history is maintained. 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. A new comment overwrites any existing comment string.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expiresIn

        StartZonalShiftRequest.Builder expiresIn​(String expiresIn)

        The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).

        If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

        To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:

        • A lowercase letter m: To specify that the value is in minutes.

        • A lowercase letter h: To specify that the value is in hours.

        For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).

        Parameters:
        expiresIn - The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time). Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).

        If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration. You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.

        To set a length of time for a zonal shift to be active, specify a whole number, and then one of the following, with no space:

        • A lowercase letter m: To specify that the value is in minutes.

        • A lowercase letter h: To specify that the value is in hours.

        For example: 20h means the zonal shift expires in 20 hours. 120m means the zonal shift expires in 120 minutes (2 hours).

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

      • resourceIdentifier

        StartZonalShiftRequest.Builder resourceIdentifier​(String resourceIdentifier)

        The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

        At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.

        Parameters:
        resourceIdentifier - The identifier for the resource that Amazon Web Services shifts traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.

        At this time, supported resources are 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.