You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ReplicationRule as input to an Aws::Client method, you can use a vanilla Hash:

{
  id: "ID",
  priority: 1,
  prefix: "Prefix",
  filter: {
    prefix: "Prefix",
    tag: {
      key: "ObjectKey", # required
      value: "Value", # required
    },
    and: {
      prefix: "Prefix",
      tags: [
        {
          key: "ObjectKey", # required
          value: "Value", # required
        },
      ],
    },
  },
  status: "Enabled", # required, accepts Enabled, Disabled
  source_selection_criteria: {
    sse_kms_encrypted_objects: {
      status: "Enabled", # required, accepts Enabled, Disabled
    },
  },
  existing_object_replication: {
    status: "Enabled", # required, accepts Enabled, Disabled
  },
  destination: { # required
    bucket: "BucketName", # required
    account: "AccountId",
    storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS
    access_control_translation: {
      owner: "Destination", # required, accepts Destination
    },
    encryption_configuration: {
      replica_kms_key_id: "ReplicaKmsKeyID",
    },
    replication_time: {
      status: "Enabled", # required, accepts Enabled, Disabled
      time: { # required
        minutes: 1,
      },
    },
    metrics: {
      status: "Enabled", # required, accepts Enabled, Disabled
      event_threshold: {
        minutes: 1,
      },
    },
  },
  delete_marker_replication: {
    status: "Enabled", # accepts Enabled, Disabled
  },
}

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

See Also:

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.

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.

Returns:

#destination ⇒ Types::Destination

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

Returns:

  • (Types::Destination) —

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

#existing_object_replication ⇒ Types::ExistingObjectReplication

Returns:

#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:

#id ⇒ String

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

Returns:

  • (String) —

    A unique identifier for the rule.

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

Returns:

  • (String) —

    An object key name prefix that identifies the object or objects to which the rule applies.

#priority ⇒ Integer

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.

Returns:

  • (Integer) —

    The priority associated with the rule.

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

Returns:

#status ⇒ String

Specifies whether the rule is enabled.

Possible values:

  • Enabled
  • Disabled

Returns:

  • (String) —

    Specifies whether the rule is enabled.