Skip to content

/AWS1/CL_S3_REPLICATIONRULE

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_status TYPE /AWS1/S3_REPLICATIONRULESTATUS /AWS1/S3_REPLICATIONRULESTATUS

Specifies whether the rule is enabled.

io_destination TYPE REF TO /AWS1/CL_S3_DESTINATION /AWS1/CL_S3_DESTINATION

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

Optional arguments:

iv_id TYPE /AWS1/S3_ID /AWS1/S3_ID

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

iv_priority TYPE /AWS1/S3_PRIORITY /AWS1/S3_PRIORITY

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination 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 Replication in the Amazon S3 User Guide.

iv_prefix TYPE /AWS1/S3_PREFIX /AWS1/S3_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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

io_filter TYPE REF TO /AWS1/CL_S3_REPLRULEFILTER /AWS1/CL_S3_REPLRULEFILTER

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.

io_sourceselectioncriteria TYPE REF TO /AWS1/CL_S3_SRCSELECTIONCRIT /AWS1/CL_S3_SRCSELECTIONCRIT

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 managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

io_existingobjectreplication TYPE REF TO /AWS1/CL_S3_EXISTINGOBJECTREPL /AWS1/CL_S3_EXISTINGOBJECTREPL

Optional configuration to replicate existing source bucket objects.

This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.

io_deletemarkerreplication TYPE REF TO /AWS1/CL_S3_DELETEMARKERREPL /AWS1/CL_S3_DELETEMARKERREPL

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

For more information about delete marker replication, see Basic Rule Configuration.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

Queryable Attributes

ID

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

Accessible with the following methods

Method Description
GET_ID() Getter for ID, with configurable default
ASK_ID() Getter for ID w/ exceptions if field has no value
HAS_ID() Determine if ID has a value

Priority

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination 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 Replication in the Amazon S3 User Guide.

Accessible with the following methods

Method Description
GET_PRIORITY() Getter for PRIORITY, with configurable default
ASK_PRIORITY() Getter for PRIORITY w/ exceptions if field has no value
HAS_PRIORITY() Determine if PRIORITY has a value

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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

Accessible with the following methods

Method Description
GET_PREFIX() Getter for PREFIX, with configurable default
ASK_PREFIX() Getter for PREFIX w/ exceptions if field has no value
HAS_PREFIX() Determine if PREFIX has a value

Filter

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.

Accessible with the following methods

Method Description
GET_FILTER() Getter for FILTER

Status

Specifies whether the rule is enabled.

Accessible with the following methods

Method Description
GET_STATUS() Getter for STATUS, with configurable default
ASK_STATUS() Getter for STATUS w/ exceptions if field has no value
HAS_STATUS() Determine if STATUS has a value

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 managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

Accessible with the following methods

Method Description
GET_SOURCESELECTIONCRITERIA() Getter for SOURCESELECTIONCRITERIA

ExistingObjectReplication

Optional configuration to replicate existing source bucket objects.

This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.

Accessible with the following methods

Method Description
GET_EXISTINGOBJECTREPL() Getter for EXISTINGOBJECTREPLICATION

Destination

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

Accessible with the following methods

Method Description
GET_DESTINATION() Getter for DESTINATION

DeleteMarkerReplication

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

For more information about delete marker replication, see Basic Rule Configuration.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

Accessible with the following methods

Method Description
GET_DELETEMARKERREPLICATION() Getter for DELETEMARKERREPLICATION

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_REPLICATIONRULES

TYPES TT_REPLICATIONRULES TYPE STANDARD TABLE OF REF TO /AWS1/CL_S3_REPLICATIONRULE WITH DEFAULT KEY
.