ReplicationRule ¶

class ReplicationRule(TypedDict, closed=True):
    id: NotRequired["capo_s3_control.types.id.ID"]
    """<p>A unique identifier for the rule. The maximum value is 255 characters.</p>"""
    priority: NotRequired["capo_s3_control.types.priority.Priority"]
    """<p>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. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-between-outposts.html">Creating replication rules on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p>"""
    prefix: NotRequired["capo_s3_control.types.prefix.Prefix"]
    """<p>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.</p> <important> <p>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints"> XML-related object key constraints</a> in the <i>Amazon S3 User Guide</i>.</p> </important>"""
    filter: NotRequired[
        "capo_s3_control.types.replication_rule_filter.ReplicationRuleFilter"
    ]
    """<p>A filter that identifies the subset of objects to which the replication rule applies. A <code>Filter</code> element must specify exactly one <code>Prefix</code>, <code>Tag</code>, or <code>And</code> child element.</p>"""
    status: "capo_s3_control.types.replication_rule_status.ReplicationRuleStatus"
    """<p>Specifies whether the rule is enabled.</p>"""
    source_selection_criteria: NotRequired[
        "capo_s3_control.types.source_selection_criteria.SourceSelectionCriteria"
    ]
    """<p>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.</p>"""
    existing_object_replication: NotRequired[
        "capo_s3_control.types.existing_object_replication.ExistingObjectReplication"
    ]
    """<p>An optional configuration to replicate existing source bucket objects. </p> <note> <p>This is not supported by Amazon S3 on Outposts buckets.</p> </note>"""
    destination: "capo_s3_control.types.destination.Destination"
    """<p>A container for information about the replication destination and its configurations.</p>"""
    delete_marker_replication: NotRequired[
        "capo_s3_control.types.delete_marker_replication.DeleteMarkerReplication"
    ]
    """<p>Specifies whether S3 on Outposts replicates delete markers. If you specify a <code>Filter</code> element 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> element's <code>Status</code> child element must be set to <code>Disabled</code>, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.</p> <p>For more information about delete marker replication, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OutpostsReplication.html#outposts-replication-what-is-replicated">How delete operations affect replication</a> in the <i>Amazon S3 User Guide</i>. </p>"""
    bucket: "capo_s3_control.types.bucket_identifier_string.BucketIdentifierString"
    """<p>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.</p>"""