/AWS1/CL_S3CREPLICATIONRULE

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

CONSTRUCTOR

IMPORTING

Required arguments:

iv_status TYPE /AWS1/S3CREPLICATIONRULESTATUS /AWS1/S3CREPLICATIONRULESTATUS

Specifies whether the rule is enabled.

io_destination TYPE REF TO /AWS1/CL_S3CDESTINATION /AWS1/CL_S3CDESTINATION

A container for information about the replication destination and its configurations.

iv_bucket TYPE /AWS1/S3CBUCKETIDSTRING /AWS1/S3CBUCKETIDSTRING

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.

Optional arguments:

iv_id TYPE /AWS1/S3CID /AWS1/S3CID

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

iv_priority TYPE /AWS1/S3CPRIORITY /AWS1/S3CPRIORITY

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.

For more information, see Creating replication rules on Outposts in the Amazon S3 User Guide.

iv_prefix TYPE /AWS1/S3CPREFIX /AWS1/S3CPREFIX

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.

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 XML-related object key constraints in the Amazon S3 User Guide.

io_filter TYPE REF TO /AWS1/CL_S3CREPLRULEFILTER /AWS1/CL_S3CREPLRULEFILTER

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

io_sourceselectioncriteria TYPE REF TO /AWS1/CL_S3CSRCSELECTIONCRIT /AWS1/CL_S3CSRCSELECTIONCRIT

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.

io_existingobjectreplication TYPE REF TO /AWS1/CL_S3CEXISTINGOBJECTREPL /AWS1/CL_S3CEXISTINGOBJECTREPL

An optional configuration to replicate existing source bucket objects.

This is not supported by Amazon S3 on Outposts buckets.

io_deletemarkerreplication TYPE REF TO /AWS1/CL_S3CDELETEMARKERREPL /AWS1/CL_S3CDELETEMARKERREPL

Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.

For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.

---

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

For more information, see Creating replication rules on Outposts 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 an Outposts bucket, specify an empty string.

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 XML-related object key constraints in the Amazon S3 User Guide.

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 element must specify exactly one Prefix, Tag, or 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 Outposts objects that you want to replicate. You can choose to enable or disable the replication of these objects.

Accessible with the following methods

Method	Description
GET_SOURCESELECTIONCRITERIA()	Getter for SOURCESELECTIONCRITERIA

ExistingObjectReplication

An optional configuration to replicate existing source bucket objects.

This is not supported by Amazon S3 on Outposts buckets.

Accessible with the following methods

Method	Description
GET_EXISTINGOBJECTREPL()	Getter for EXISTINGOBJECTREPLICATION

Destination

A container for information about the replication destination and its configurations.

Accessible with the following methods

Method	Description
GET_DESTINATION()	Getter for DESTINATION

DeleteMarkerReplication

Specifies whether S3 on Outposts replicates delete markers. If you specify a Filter element in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication element's Status child element must be set to Disabled, because S3 on Outposts doesn't support replicating delete markers for tag-based rules.

For more information about delete marker replication, see How delete operations affect replication in the Amazon S3 User Guide.

Accessible with the following methods

Method	Description
GET_DELETEMARKERREPLICATION()	Getter for DELETEMARKERREPLICATION

Bucket

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.

Accessible with the following methods

Method	Description
GET_BUCKET()	Getter for BUCKET, with configurable default
ASK_BUCKET()	Getter for BUCKET w/ exceptions if field has no value
HAS_BUCKET()	Determine if BUCKET has a value

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_S3CREPLICATIONRULE WITH DEFAULT KEY
.