AWSS3ReplicationRule

Objective-C

@interface AWSS3ReplicationRule

Swift

class AWSS3ReplicationRule

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

Required parameters: [Status, Destination]

  • 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.

    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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3DeleteMarkerReplication *_Nullable deleteMarkerReplication;

    Swift

    var deleteMarkerReplication: AWSS3DeleteMarkerReplication? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3Destination *_Nullable destination;

    Swift

    var destination: AWSS3Destination? { get set }

  • Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3ExistingObjectReplication *_Nullable existingObjectReplication;

    Swift

    var existingObjectReplication: AWSS3ExistingObjectReplication? { get set }

  • 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 element.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3ReplicationRuleFilter *_Nullable filter;

    Swift

    var filter: AWSS3ReplicationRuleFilter? { get set }

  • A unique identifier for the rule. The maximum value is 255 characters.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable identifier;

    Swift

    var identifier: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable prefix;

    Swift

    var prefix: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable priority;

    Swift

    var priority: NSNumber? { get set }

  • 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).

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSS3SourceSelectionCriteria *_Nullable sourceSelectionCriteria;

    Swift

    var sourceSelectionCriteria: AWSS3SourceSelectionCriteria? { get set }

  • Specifies whether the rule is enabled.

    Declaration

    Objective-C

    @property (nonatomic) AWSS3ReplicationRuleStatus status;

    Swift

    var status: AWSS3ReplicationRuleStatus { get set }