Package software.amazon.awssdk.services.s3control.model

Interface MultiRegionAccessPointRoute.Builder

All Superinterfaces:
Buildable, CopyableBuilder<MultiRegionAccessPointRoute.Builder,MultiRegionAccessPointRoute>, SdkBuilder<MultiRegionAccessPointRoute.Builder,MultiRegionAccessPointRoute>, SdkPojo
Enclosing class:
MultiRegionAccessPointRoute
public static interface MultiRegionAccessPointRoute.Builder extends SdkPojo, CopyableBuilder<MultiRegionAccessPointRoute.Builder,MultiRegionAccessPointRoute>

  • Method Details

    • bucket

      MultiRegionAccessPointRoute.Builder bucket(String bucket)

      The name of the Amazon S3 bucket for which you'll submit a routing configuration change. Either the Bucket or the Region value must be provided. If both are provided, the bucket must be in the specified Region.

      Parameters:
      bucket - The name of the Amazon S3 bucket for which you'll submit a routing configuration change. Either the Bucket or the Region value must be provided. If both are provided, the bucket must be in the specified Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • region

      MultiRegionAccessPointRoute.Builder region(String region)

      The Amazon Web Services Region to which you'll be submitting a routing configuration change. Either the Bucket or the Region value must be provided. If both are provided, the bucket must be in the specified Region.

      Parameters:
      region - The Amazon Web Services Region to which you'll be submitting a routing configuration change. Either the Bucket or the Region value must be provided. If both are provided, the bucket must be in the specified Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • trafficDialPercentage

      MultiRegionAccessPointRoute.Builder trafficDialPercentage(Integer trafficDialPercentage)

      The traffic state for the specified bucket or Amazon Web Services Region.

      A value of 0 indicates a passive state, which means that no new traffic will be routed to the Region.

      A value of 100 indicates an active state, which means that traffic will be routed to the specified Region.

      When the routing configuration for a Region is changed from active to passive, any in-progress operations (uploads, copies, deletes, and so on) to the formerly active Region will continue to run to until a final success or failure status is reached.

      If all Regions in the routing configuration are designated as passive, you'll receive an InvalidRequest error.

      Parameters:
      trafficDialPercentage - The traffic state for the specified bucket or Amazon Web Services Region.

      A value of 0 indicates a passive state, which means that no new traffic will be routed to the Region.

      A value of 100 indicates an active state, which means that traffic will be routed to the specified Region.

      When the routing configuration for a Region is changed from active to passive, any in-progress operations (uploads, copies, deletes, and so on) to the formerly active Region will continue to run to until a final success or failure status is reached.

      If all Regions in the routing configuration are designated as passive, you'll receive an InvalidRequest error.

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