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

Class MultiRegionAccessPointRoute

java.lang.Object
software.amazon.awssdk.services.s3control.model.MultiRegionAccessPointRoute
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MultiRegionAccessPointRoute.Builder,MultiRegionAccessPointRoute>
@Generated("software.amazon.awssdk:codegen") public final class MultiRegionAccessPointRoute extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MultiRegionAccessPointRoute.Builder,MultiRegionAccessPointRoute>

A structure for a Multi-Region Access Point that indicates where Amazon S3 traffic can be routed. Routes can be either active or passive. Active routes can process Amazon S3 requests through the Multi-Region Access Point, but passive routes are not eligible to process Amazon S3 requests.

Each route contains the Amazon S3 bucket name and the Amazon Web Services Region that the bucket is located in. The route also includes the TrafficDialPercentage value, which shows whether the bucket and Region are active (indicated by a value of 100) or passive (indicated by a value of 0).

See Also:

  • Method Details

    • bucket

      public final 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.

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

    • region

      public final 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.

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

    • trafficDialPercentage

      public final 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.

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

    • toBuilder

      public MultiRegionAccessPointRoute.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MultiRegionAccessPointRoute.Builder,MultiRegionAccessPointRoute>
      Returns:
      a builder for type T

    • builder

      public static MultiRegionAccessPointRoute.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MultiRegionAccessPointRoute.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.