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(value="software.amazon.awssdk:codegen")
public final class ReplicationRule
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReplicationRule.Builder,ReplicationRule>

A container for information about a specific replication rule.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReplicationRule.Builder

Method Summary

Modifier and Type	Method and 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.
boolean	equals(Object obj)
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() An object keyname prefix that identifies the object or objects to which the rule applies.
Integer	priority() The priority associated with the rule.
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() If status isn't enabled, the rule is ignored.
String	statusAsString() If status isn't enabled, the rule is ignored.
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 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 Integer priority()

The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example:

• Same object quality prefix based filter criteria If prefixes you specified in multiple rules overlap

• Same object qualify tag based filter criteria specified in multiple rules

For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

Returns:

The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example:

• Same object quality prefix based filter criteria If prefixes you specified in multiple rules overlap

• Same object qualify tag based filter criteria specified in multiple rules

For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

prefix

public String prefix()

An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters.

Returns:

An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters.

filter

public ReplicationRuleFilter filter()

Returns the value of the Filter property for this object.

Returns:

The value of the Filter property for this object.

status

public ReplicationRuleStatus status()

If status isn't enabled, the rule is ignored.

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:

If status isn't enabled, the rule is ignored.

See Also:

ReplicationRuleStatus

statusAsString

public String statusAsString()

If status isn't enabled, the rule is ignored.

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:

If status isn't enabled, the rule is ignored.

See Also:

ReplicationRuleStatus

sourceSelectionCriteria

public 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 an AWS KMS-Managed Key (SSE-KMS).

If you want Amazon S3 to replicate objects created with server-side encryption using AWS KMS-Managed Keys.

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 an AWS KMS-Managed Key (SSE-KMS).

If you want Amazon S3 to replicate objects created with server-side encryption using AWS KMS-Managed Keys.

destination

public Destination destination()

A container for information about the replication destination.

Returns:

A container for information about the replication destination.

deleteMarkerReplication

public 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo