ReplicationRule (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.s3control.model.ReplicationRule

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReplicationRule
extends Object
implements Serializable, Cloneable
```
Specifies which S3 on Outposts objects to replicate and where to store the replicas.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ReplicationRule()

Constructors
Constructor and Description
`ReplicationRule()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ReplicationRule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBucket()` The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
`DeleteMarkerReplication`	`getDeleteMarkerReplication()` Specifies whether S3 on Outposts replicates delete markers.
`Destination`	`getDestination()` A container for information about the replication destination and its configurations.
`ExistingObjectReplication`	`getExistingObjectReplication()` An optional configuration to replicate existing source bucket objects.
`ReplicationRuleFilter`	`getFilter()` A filter that identifies the subset of objects to which the replication rule applies.
`String`	`getID()` A unique identifier for the rule.
`String`	`getPrefix()` Deprecated.
`Integer`	`getPriority()` The priority indicates which rule has precedence whenever two or more replication rules conflict.
`SourceSelectionCriteria`	`getSourceSelectionCriteria()` A container that describes additional filters for identifying the source Outposts objects that you want to replicate.
`String`	`getStatus()` Specifies whether the rule is enabled.
`int`	`hashCode()`
`void`	`setBucket(String bucket)` The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
`void`	`setDeleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication)` Specifies whether S3 on Outposts replicates delete markers.
`void`	`setDestination(Destination destination)` A container for information about the replication destination and its configurations.
`void`	`setExistingObjectReplication(ExistingObjectReplication existingObjectReplication)` An optional configuration to replicate existing source bucket objects.
`void`	`setFilter(ReplicationRuleFilter filter)` A filter that identifies the subset of objects to which the replication rule applies.
`void`	`setID(String iD)` A unique identifier for the rule.
`void`	`setPrefix(String prefix)` Deprecated.
`void`	`setPriority(Integer priority)` The priority indicates which rule has precedence whenever two or more replication rules conflict.
`void`	`setSourceSelectionCriteria(SourceSelectionCriteria sourceSelectionCriteria)` A container that describes additional filters for identifying the source Outposts objects that you want to replicate.
`void`	`setStatus(String status)` Specifies whether the rule is enabled.
`String`	`toString()` Returns a string representation of this object.
`ReplicationRule`	`withBucket(String bucket)` The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
`ReplicationRule`	`withDeleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication)` Specifies whether S3 on Outposts replicates delete markers.
`ReplicationRule`	`withDestination(Destination destination)` A container for information about the replication destination and its configurations.
`ReplicationRule`	`withExistingObjectReplication(ExistingObjectReplication existingObjectReplication)` An optional configuration to replicate existing source bucket objects.
`ReplicationRule`	`withFilter(ReplicationRuleFilter filter)` A filter that identifies the subset of objects to which the replication rule applies.
`ReplicationRule`	`withID(String iD)` A unique identifier for the rule.
`ReplicationRule`	`withPrefix(String prefix)` Deprecated.
`ReplicationRule`	`withPriority(Integer priority)` The priority indicates which rule has precedence whenever two or more replication rules conflict.
`ReplicationRule`	`withSourceSelectionCriteria(SourceSelectionCriteria sourceSelectionCriteria)` A container that describes additional filters for identifying the source Outposts objects that you want to replicate.
`ReplicationRule`	`withStatus(ReplicationRuleStatus status)` Specifies whether the rule is enabled.
`ReplicationRule`	`withStatus(String status)` Specifies whether the rule is enabled.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ReplicationRule
```
public ReplicationRule()
```
- Method Detail
  - setID
```
public void setID(String iD)
```
    A unique identifier for the rule. The maximum value is 255 characters.
    
    Parameters:
    
    iD - A unique identifier for the rule. The maximum value is 255 characters.
  - getID
```
public String getID()
```
    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.
  - withID
```
public ReplicationRule withID(String iD)
```
    A unique identifier for the rule. The maximum value is 255 characters.
    
    Parameters:
    
    iD - A unique identifier for the rule. The maximum value is 255 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts 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 Creating replication rules on Outposts in the Amazon S3 User Guide.
    
    Parameters:
    
    priority - The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts 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 Creating replication rules on Outposts in the Amazon S3 User Guide.
  - getPriority
```
public Integer getPriority()
```
    The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts 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 Creating replication rules on Outposts in the Amazon S3 User Guide.
    
    Returns:
    
    The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts 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 Creating replication rules on Outposts in the Amazon S3 User Guide.
  - withPriority
```
public ReplicationRule withPriority(Integer priority)
```
    The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts 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 Creating replication rules on Outposts in the Amazon S3 User Guide.
    
    Parameters:
    
    priority - The priority indicates which rule has precedence whenever two or more replication rules conflict. S3 on Outposts attempts to replicate objects according to all replication rules. However, if there are two or more rules with the same destination Outposts 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 Creating replication rules on Outposts in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrefix
```
@Deprecated
public void setPrefix(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 an Outposts bucket, specify an empty string.
    
    When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.
    
    Parameters:
    
    prefix - 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 an Outposts bucket, specify an empty string.
    
    When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.
  - getPrefix
```
@Deprecated
public String getPrefix()
```
    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 an Outposts bucket, specify an empty string.
    
    When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.
    
    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 an Outposts bucket, specify an empty string.
    
    When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.
  - withPrefix
```
@Deprecated
public ReplicationRule withPrefix(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 an Outposts bucket, specify an empty string.
    
    When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.
    
    Parameters:
    
    prefix - 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 an Outposts bucket, specify an empty string.
    
    When you're using XML requests, you must replace special characters (such as carriage returns) in object keys with their equivalent XML entity codes. For more information, see XML-related object key constraints in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFilter
```
public void setFilter(ReplicationRuleFilter filter)
```
    A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.
    
    Parameters:
    
    filter - A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.
  - getFilter
```
public ReplicationRuleFilter getFilter()
```
    A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.
    
    Returns:
    
    A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.
  - withFilter
```
public ReplicationRule withFilter(ReplicationRuleFilter filter)
```
    A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.
    
    Parameters:
    
    filter - A filter that identifies the subset of objects to which the replication rule applies. A Filter element must specify exactly one Prefix, Tag, or And child element.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Specifies whether the rule is enabled.
    
    Parameters:
    
    status - Specifies whether the rule is enabled.
    
    See Also:
    
    ReplicationRuleStatus
  - getStatus
```
public String getStatus()
```
    Specifies whether the rule is enabled.
    
    Returns:
    
    Specifies whether the rule is enabled.
    
    See Also:
    
    ReplicationRuleStatus
  - withStatus
```
public ReplicationRule withStatus(String status)
```
    Specifies whether the rule is enabled.
    
    Parameters:
    
    status - Specifies whether the rule is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReplicationRuleStatus
  - withStatus
```
public ReplicationRule withStatus(ReplicationRuleStatus status)
```
    Specifies whether the rule is enabled.
    
    Parameters:
    
    status - Specifies whether the rule is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReplicationRuleStatus
  - setSourceSelectionCriteria
```
public void setSourceSelectionCriteria(SourceSelectionCriteria sourceSelectionCriteria)
```
    A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.
    
    Parameters:
    
    sourceSelectionCriteria - A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.
  - getSourceSelectionCriteria
```
public SourceSelectionCriteria getSourceSelectionCriteria()
```
    A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.
    
    Returns:
    
    A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.
  - withSourceSelectionCriteria
```
public ReplicationRule withSourceSelectionCriteria(SourceSelectionCriteria sourceSelectionCriteria)
```
    A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.
    
    Parameters:
    
    sourceSelectionCriteria - A container that describes additional filters for identifying the source Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExistingObjectReplication
```
public void setExistingObjectReplication(ExistingObjectReplication existingObjectReplication)
```
    An optional configuration to replicate existing source bucket objects.
    
    This is not supported by Amazon S3 on Outposts buckets.
    
    Parameters:
    
    existingObjectReplication - An optional configuration to replicate existing source bucket objects.
    
    This is not supported by Amazon S3 on Outposts buckets.
  - getExistingObjectReplication
```
public ExistingObjectReplication getExistingObjectReplication()
```
    An optional configuration to replicate existing source bucket objects.
    
    This is not supported by Amazon S3 on Outposts buckets.
    
    Returns:
    
    An optional configuration to replicate existing source bucket objects.
    
    This is not supported by Amazon S3 on Outposts buckets.
  - withExistingObjectReplication
```
public ReplicationRule withExistingObjectReplication(ExistingObjectReplication existingObjectReplication)
```
    An optional configuration to replicate existing source bucket objects.
    
    This is not supported by Amazon S3 on Outposts buckets.
    
    Parameters:
    
    existingObjectReplication - An optional configuration to replicate existing source bucket objects.
    
    This is not supported by Amazon S3 on Outposts buckets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDestination
```
public void setDestination(Destination destination)
```
    A container for information about the replication destination and its configurations.
    
    Parameters:
    
    destination - A container for information about the replication destination and its configurations.
  - getDestination
```
public Destination getDestination()
```
    A container for information about the replication destination and its configurations.
    
    Returns:
    
    A container for information about the replication destination and its configurations.
  - withDestination
```
public ReplicationRule withDestination(Destination destination)
```
    A container for information about the replication destination and its configurations.
    
    Parameters:
    
    destination - A container for information about the replication destination and its configurations.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeleteMarkerReplication
```
public void setDeleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication)
```
    Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.
    
    For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.
    
    Parameters:
    
    deleteMarkerReplication - Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.
    
    For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.
  - getDeleteMarkerReplication
```
public DeleteMarkerReplication getDeleteMarkerReplication()
```
    Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.
    
    For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.
    
    Returns:
    
    Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.
    
    For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.
  - withDeleteMarkerReplication
```
public ReplicationRule withDeleteMarkerReplication(DeleteMarkerReplication deleteMarkerReplication)
```
    Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.
    
    For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.
    
    Parameters:
    
    deleteMarkerReplication - Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.
    
    For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucket
```
public void setBucket(String bucket)
```
    The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
    
    Parameters:
    
    bucket - The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
  - getBucket
```
public String getBucket()
```
    The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
  - withBucket
```
public ReplicationRule withBucket(String bucket)
```
    The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
    
    Parameters:
    
    bucket - The Amazon Resource Name (ARN) of the access point for the source Outposts bucket that you want S3 on Outposts to replicate the objects from.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ReplicationRule clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.781

Class ReplicationRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReplicationRule

Method Detail

setID

getID

withID

setPriority

getPriority

withPriority

setPrefix

getPrefix

withPrefix

setFilter

getFilter

withFilter

setStatus

getStatus

withStatus

withStatus

setSourceSelectionCriteria

getSourceSelectionCriteria

withSourceSelectionCriteria

setExistingObjectReplication

getExistingObjectReplication

withExistingObjectReplication

setDestination

getDestination

withDestination

setDeleteMarkerReplication

getDeleteMarkerReplication

withDeleteMarkerReplication

setBucket

getBucket

withBucket

toString

equals

hashCode

clone