Interface CfnBucket.IFilterRuleProperty
Specifies the Amazon S3 object key name to filter on.
Namespace: Amazon.CDK.AWS.S3
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IFilterRulePropertySyntax (vb)
Public Interface IFilterRulePropertyRemarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.S3;
var filterRuleProperty = new FilterRuleProperty {
Name = "name",
Value = "value"
};Synopsis
Properties
| Name | The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. |
| Value | The value that the filter searches for in object key names. |
Properties
Name
The object key name prefix or suffix identifying one or more objects to which the filtering rule applies.
string Name { get; }Property Value
System.String
Remarks
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 .
Value
The value that the filter searches for in object key names.
string Value { get; }Property Value
System.String