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
    },
  },
  destination: { # required
    bucket: "BucketName", # required
    account: "AccountId",
    storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA
    access_control_translation: {
      owner: "Destination", # required, accepts Destination
    },
    encryption_configuration: {
      replica_kms_key_id: "ReplicaKmsKeyID",
    },
  },
  delete_marker_replication: {
    status: "Enabled", # accepts Enabled, Disabled
  },
}

Container for information about a particular replication rule.

Instance Attribute Summary collapse

Instance Attribute Details

#delete_marker_replicationTypes::DeleteMarkerReplication

Specifies whether Amazon S3 should replicate delete makers.

Returns:

#destinationTypes::Destination

Container for replication destination information.

Returns:

#filterTypes::ReplicationRuleFilter

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

Returns:

#idString

Unique identifier for the rule. The value cannot be longer than 255 characters.

Returns:

  • (String)

    Unique identifier for the rule.

#prefixString

Object keyname prefix identifying one or more objects to which the rule applies. Maximum prefix length can be up to 1,024 characters.

Returns:

  • (String)

    Object keyname prefix identifying one or more objects to which the rule applies.

#priorityInteger

The priority associated with the rule. If you specify multiple rules in a replication configuration, then Amazon S3 applies rule priority in the event there are conflicts (two or more rules identify the same object based on filter specified). 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 Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

Returns:

  • (Integer)

    The priority associated with the rule.

#source_selection_criteriaTypes::SourceSelectionCriteria

Container that describes additional filters in identifying source objects that you want to replicate. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-managed key. You can choose to enable or disable replication of these objects.

if you want Amazon S3 to replicate objects created with server-side encryption using AWS KMS-managed keys.

Returns:

#statusString

The rule is ignored if status is not Enabled.

Possible values:

  • Enabled
  • Disabled

Returns:

  • (String)

    The rule is ignored if status is not Enabled.