Class: Aws::S3::Types::ReplicationRuleFilter

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 ReplicationRuleFilter data as a hash:

{
  prefix: "Prefix",
  tag: {
    key: "ObjectKey", # required
    value: "Value", # required
  },
  and: {
    prefix: "Prefix",
    tags: [
      {
        key: "ObjectKey", # required
        value: "Value", # required
      },
    ],
  },
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#andTypes::ReplicationRuleAndOperator

A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:

  • If you specify both a `Prefix` and a `Tag` filter, wrap these filters in an `And` tag.

  • If you specify a filter based on multiple tags, wrap the `Tag` elements in an `And` tag.


13201
13202
13203
13204
13205
13206
13207
# File 'lib/aws-sdk-s3/types.rb', line 13201

class ReplicationRuleFilter < Struct.new(
  :prefix,
  :tag,
  :and)
  SENSITIVE = []
  include Aws::Structure
end

#prefixString

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

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)

13201
13202
13203
13204
13205
13206
13207
# File 'lib/aws-sdk-s3/types.rb', line 13201

class ReplicationRuleFilter < Struct.new(
  :prefix,
  :tag,
  :and)
  SENSITIVE = []
  include Aws::Structure
end

#tagTypes::Tag

A container for specifying a tag key and value.

The rule applies only to objects that have the tag in their tag set.

Returns:


13201
13202
13203
13204
13205
13206
13207
# File 'lib/aws-sdk-s3/types.rb', line 13201

class ReplicationRuleFilter < Struct.new(
  :prefix,
  :tag,
  :and)
  SENSITIVE = []
  include Aws::Structure
end