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

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

Overview

Note:

When making an API call, you may pass ReplicationRule data as a 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, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE
    access_control_translation: {
      owner: "Destination", # required, accepts Destination
    },
    encryption_configuration: {
      replica_kms_key_id: "ReplicaKmsKeyID",
    },
  },
  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

Returns:



8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
 
# File 'lib/aws-sdk-s3/types.rb', line 8581

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

#destination ⇒ Types::Destination

A container for information about the replication destination.

Returns:



8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
 
# File 'lib/aws-sdk-s3/types.rb', line 8581

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

#filter ⇒ Types::ReplicationRuleFilter

Returns:



8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
 
# File 'lib/aws-sdk-s3/types.rb', line 8581

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

#id ⇒ String

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

Returns:

  • (String) 


8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
 
# File 'lib/aws-sdk-s3/types.rb', line 8581

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

#prefix ⇒ String

An object keyname 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) 


8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
 
# File 'lib/aws-sdk-s3/types.rb', line 8581

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

#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 [Cross-Region Replication (CRR)] in the *Amazon S3 Developer Guide*.

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

Returns:

  • (Integer) 


8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
 
# File 'lib/aws-sdk-s3/types.rb', line 8581

class ReplicationRule < Struct.new(
  :id,
  :priority,
  :prefix,
  :filter,
  :status,
  :source_selection_criteria,
  :destination,
  :delete_marker_replication)
  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 an AWS KMS-Managed Key (SSE-KMS).

Returns:



8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
 
# File 'lib/aws-sdk-s3/types.rb', line 8581

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

#status ⇒ String

Specifies whether the rule is enabled.

Returns:

  • (String) 


8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
 
# File 'lib/aws-sdk-s3/types.rb', line 8581

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