aws-cdk-lib.aws_s3.CfnBucket.FilterRuleProperty

FilterRuleProperty Struct

Specifies the Amazon S3 object key name to filter on.

An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023- or engineering/ . Then, you can use FilterRule to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
const filterRuleProperty: s3.CfnBucket.FilterRuleProperty = {
  name: 'name',
  value: 'value',
};

Properties

namestringnamestrnameStringNamestringName*stringrequired#

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.

notes

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 .

valuestringvaluestrvalueStringValuestringValue*stringrequired#

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