AWS::S3::Bucket ReplicationRule - AWS CloudFormation

AWS::S3::Bucket ReplicationRule

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

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

Properties

DeleteMarkerReplication

Specifies whether Amazon S3 replicates the delete markers. If you specify a Filter, you must specify this element. However, in the latest version of replication configuration (when Filter is specified), Amazon S3 doesn't replicate delete markers. Therefore, the DeleteMarkerReplication element can contain only <Status>Disabled</Status>. For an example configuration, see Basic Rule Configuration.

Note

If you don't specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, Amazon S3 handled replication of delete markers differently. For more information, see Backward Compatibility.

Required: No

Type: DeleteMarkerReplication

Update requires: No interruption

Destination

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

Required: Yes

Type: ReplicationDestination

Update requires: No interruption

Filter

A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, TagFilter, or an And child element.

Required: No

Type: ReplicationRuleFilter

Update requires: No interruption

Id

A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID.

Required: No

Type: String

Update requires: No interruption

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 a bucket, specify an empty string.

Required: No

Type: String

Update requires: No interruption

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 Replication in the Amazon Simple Storage Service Developer Guide.

Required: No

Type: Integer

Update requires: No interruption

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 master key (CMK) stored in AWS Key Management Service (SSE-KMS).

Required: No

Type: SourceSelectionCriteria

Update requires: No interruption

Status

Specifies whether the rule is enabled.

Required: Yes

Type: String

Allowed values: Disabled | Enabled

Update requires: No interruption