aws-cdk-lib.aws_s3.CfnBucket.S3KeyFilterProperty

interface S3KeyFilterProperty

LanguageType name
.NETAmazon.CDK.AWS.S3.CfnBucket.S3KeyFilterProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnBucket_S3KeyFilterProperty
Javasoftware.amazon.awscdk.services.s3.CfnBucket.S3KeyFilterProperty
Pythonaws_cdk.aws_s3.CfnBucket.S3KeyFilterProperty
TypeScript aws-cdk-lib » aws_s3 » CfnBucket » S3KeyFilterProperty

A container for object key name prefix and suffix filtering rules.

For more information about object key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide .

The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules.

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 s3KeyFilterProperty: s3.CfnBucket.S3KeyFilterProperty = {
  rules: [{
    name: 'name',
    value: 'value',
  }],
};

Properties

NameTypeDescription
rulesIResolvable | IResolvable | FilterRuleProperty[]A list of containers for the key-value pair that defines the criteria for the filter rule.

rules

Type: IResolvable | IResolvable | FilterRuleProperty[]

A list of containers for the key-value pair that defines the criteria for the filter rule.