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

Interface StartZonalShiftRequest.Builder

All Superinterfaces:
ArcZonalShiftRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<StartZonalShiftRequest.Builder,StartZonalShiftRequest>, SdkBuilder<StartZonalShiftRequest.Builder,StartZonalShiftRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartZonalShiftRequest
public static interface StartZonalShiftRequest.Builder extends ArcZonalShiftRequest.Builder, SdkPojo, CopyableBuilder<StartZonalShiftRequest.Builder,StartZonalShiftRequest>

  • Method Details

    • awayFrom

      StartZonalShiftRequest.Builder awayFrom(String awayFrom)

      The Availability Zone 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 AWS Region.

      Parameters:
      awayFrom - The Availability Zone 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 AWS 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: 

        <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p>
      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: 

        <ul> <li> <p> <b>A lowercase letter m:</b> To specify that the value is in minutes.</p> </li> <li> <p> <b>A lowercase letter h:</b> To specify that the value is in hours.</p> </li> </ul> <p>For example: <code>20h</code> means the zonal shift expires in 20 hours. <code>120m</code> means the zonal shift expires in 120 minutes (2 hours).</p>
      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 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.

    • overrideConfiguration

      StartZonalShiftRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartZonalShiftRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.