Package software.amazon.awssdk.services.s3.model

Class ReplicationRule

java.lang.Object

software.amazon.awssdk.services.s3.model.ReplicationRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ReplicationRule.Builder,ReplicationRule>

@Generated("software.amazon.awssdk:codegen")
public final class ReplicationRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReplicationRule.Builder,ReplicationRule>

Specifies which Amazon S3 objects to replicate and where to store the replicas.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReplicationRule.Builder

Method Summary

Modifier and Type	Method	Description
static ReplicationRule.Builder	builder()
DeleteMarkerReplication	deleteMarkerReplication()	Returns the value of the DeleteMarkerReplication property for this object.
Destination	destination()	A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ExistingObjectReplication	existingObjectReplication()	Optional configuration to replicate existing source bucket objects.
ReplicationRuleFilter	filter()	Returns the value of the Filter property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	A unique identifier for the rule.
String	prefix()	Deprecated.
Integer	priority()	The priority indicates which rule has precedence whenever two or more replication rules conflict.
List<SdkField<?>>	sdkFields()
static Class<? extends ReplicationRule.Builder>	serializableBuilderClass()
SourceSelectionCriteria	sourceSelectionCriteria()	A container that describes additional filters for identifying the source objects that you want to replicate.
ReplicationRuleStatus	status()	Specifies whether the rule is enabled.
String	statusAsString()	Specifies whether the rule is enabled.
ReplicationRule.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

id

public final String id()

A unique identifier for the rule. The maximum value is 255 characters.

Returns:

A unique identifier for the rule. The maximum value is 255 characters.

priority

public final Integer priority()

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon S3 User Guide.

Returns:

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon S3 User Guide.

prefix

@Deprecated
public final String prefix()

Deprecated.

An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

Returns:

An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

filter

public final ReplicationRuleFilter filter()

Returns the value of the Filter property for this object.

Returns:

The value of the Filter property for this object.

status

public final ReplicationRuleStatus status()

Specifies whether the rule is enabled.

If the service returns an enum value that is not available in the current SDK version, status will return ReplicationRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Specifies whether the rule is enabled.

See Also:

ReplicationRuleStatus

statusAsString

public final String statusAsString()

Specifies whether the rule is enabled.

If the service returns an enum value that is not available in the current SDK version, status will return ReplicationRuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Specifies whether the rule is enabled.

See Also:

ReplicationRuleStatus

sourceSelectionCriteria

public final SourceSelectionCriteria sourceSelectionCriteria()

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

Returns:

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

existingObjectReplication

public final ExistingObjectReplication existingObjectReplication()

Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide.

Returns:

Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 User Guide.

destination

public final Destination destination()

A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

Returns:

A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

deleteMarkerReplication

public final DeleteMarkerReplication deleteMarkerReplication()

Returns the value of the DeleteMarkerReplication property for this object.

Returns:

The value of the DeleteMarkerReplication property for this object.

toBuilder

public ReplicationRule.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReplicationRule.Builder,ReplicationRule>

builder

public static ReplicationRule.Builder builder()

serializableBuilderClass

public static Class<? extends ReplicationRule.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