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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MultiRegionAccessPointRoute.Builder

Method Summary

Modifier and Type	Method	Description
String	bucket()	The name of the Amazon S3 bucket for which you'll submit a routing configuration change.
static MultiRegionAccessPointRoute.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	region()	The Amazon Web Services Region to which you'll be submitting a routing configuration change.
List<SdkField<?>>	sdkFields()
static Class<? extends MultiRegionAccessPointRoute.Builder>	serializableBuilderClass()
MultiRegionAccessPointRoute.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	trafficDialPercentage()	The traffic state for the specified bucket or Amazon Web Services Region.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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()

Specified by:

toBuilder in interface ToCopyableBuilder<MultiRegionAccessPointRoute.Builder,MultiRegionAccessPointRoute>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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