Class: Aws::S3::Types::FilterRule

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

{
  name: "prefix", # accepts prefix, suffix
  value: "FilterRuleValue",
}

Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications] in the *Amazon S3 User Guide*.

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

Returns:

  • (String)

4257
4258
4259
4260
4261
4262
# File 'lib/aws-sdk-s3/types.rb', line 4257

class FilterRule < Struct.new(
  :name,
  :value)
  SENSITIVE = []
  include Aws::Structure
end

#valueString

The value that the filter searches for in object key names.

Returns:

  • (String)

4257
4258
4259
4260
4261
4262
# File 'lib/aws-sdk-s3/types.rb', line 4257

class FilterRule < Struct.new(
  :name,
  :value)
  SENSITIVE = []
  include Aws::Structure
end