interface ReplicationRuleFilterProperty

Language	Type name
.NET	`Amazon.CDK.AWS.S3.CfnBucket.ReplicationRuleFilterProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnBucket_ReplicationRuleFilterProperty`
Java	`software.amazon.awscdk.services.s3.CfnBucket.ReplicationRuleFilterProperty`
Python	`aws_cdk.aws_s3.CfnBucket.ReplicationRuleFilterProperty`
TypeScript	`aws-cdk-lib` » `aws_s3` » `CfnBucket` » `ReplicationRuleFilterProperty`

A filter that identifies the subset of objects to which the replication rule applies.

A Filter must specify exactly one Prefix , TagFilter , or an And child element.

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 replicationRuleFilterProperty: s3.CfnBucket.ReplicationRuleFilterProperty = {
  and: {
    prefix: 'prefix',
    tagFilters: [{
      key: 'key',
      value: 'value',
    }],
  },
  prefix: 'prefix',
  tagFilter: {
    key: 'key',
    value: 'value',
  },
};

Properties

Name	Type	Description
and?	`IResolvable` `\|` `ReplicationRuleAndOperatorProperty`	A container for specifying rule filters.
prefix?	`string`	An object key name prefix that identifies the subset of objects to which the rule applies.
tagFilter?	`IResolvable` `\|` `TagFilterProperty`	A container for specifying a tag key and value.

and?

Type: IResolvable | ReplicationRuleAndOperatorProperty (optional)

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 TagFilter , wrap these filters in an And tag.
If you specify a filter based on multiple tags, wrap the TagFilter elements in an And tag.

prefix?

Type: string (optional)

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 .

tagFilter?

Type: IResolvable | TagFilterProperty (optional)

A container for specifying a tag key and value.

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