Amazon S3 API · Schema

ReplicationRule

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

Cloud StorageObject StorageStorage

Properties

Name Type Description
ID object
Priority object
Prefix object
Filter object A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child
Status object
SourceSelectionCriteria object
ExistingObjectReplication object
Destination object
DeleteMarkerReplication object

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element.

View JSON Schema on GitHub

JSON Schema

s3-replicationrule-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ReplicationRule",
  "type": "object",
  "properties": {
    "ID": {},
    "Priority": {},
    "Prefix": {},
    "Filter": {
      "type": "object",
      "properties": {
        "Prefix": {},
        "Tag": {},
        "And": {}
      },
      "description": "A filter that identifies the subset of objects to which the replication rule applies. A <code>Filter</code> must specify exactly one <code>Prefix</code>, <code>Tag</code>, or an <code>And</code> child element."
    },
    "Status": {},
    "SourceSelectionCriteria": {},
    "ExistingObjectReplication": {},
    "Destination": {},
    "DeleteMarkerReplication": {
      "type": "object",
      "properties": {
        "Status": {}
      },
      "description": "<p>Specifies whether Amazon S3 replicates delete markers. If you specify a <code>Filter</code> in your replication configuration, you must also include a <code>DeleteMarkerReplication</code> element. If your <code>Filter</code> includes a <code>Tag</code> element, the <code>DeleteMarkerReplication</code> <code>Status</code> must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config\">Basic Rule Configuration</a>. </p> <p>For more information about delete marker replication, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html\">Basic Rule Configuration</a>. </p> <note> <p>If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations\">Backward Compatibility</a>.</p> </note>"
    }
  },
  "required": [
    "Status",
    "Destination"
  ],
  "description": "Specifies which Amazon S3 objects to replicate and where to store the replicas."
}