Class: Aws::S3::Types::ReplicationRule

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-s3/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delete_marker_replication ⇒ Types::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].

<note markdown=“1”> 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].

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config [2]: docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html [3]: docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations

Returns:



16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end

#destination ⇒ Types::Destination

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

Returns:



16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end

#existing_object_replication ⇒ Types::ExistingObjectReplication

Optional configuration to replicate existing source bucket objects.

<note markdown=“1”> This parameter is no longer supported. To replicate existing objects, see [Replicating existing objects with S3 Batch Replication] in the *Amazon S3 User Guide*.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/s3-batch-replication-batch.html

Returns:



16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end

#filter ⇒ Types::ReplicationRuleFilter

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.

Returns:



16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

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

Returns:

  • (String) 


16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end

#prefix ⇒ String

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

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints

Returns:

  • (String) 


16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end

#priority ⇒ Integer

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

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/replication.html

Returns:

  • (Integer) 


16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end

#source_selection_criteria ⇒ Types::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).

Returns:



16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

Specifies whether the rule is enabled.

Returns:

  • (String) 


16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
 
# File 'lib/aws-sdk-s3/types.rb', line 16097

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :existing_object_replication,
  :destination,
  :delete_marker_replication)
  SENSITIVE = []
  include Aws::Structure
end