software.amazon.awscdk.services.s3

Interface CfnBucket.S3KeyFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.S3KeyFilterProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(value=Stable)
public static interface CfnBucket.S3KeyFilterProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.s3.*;
 S3KeyFilterProperty s3KeyFilterProperty = S3KeyFilterProperty.builder()
         .rules(List.of(FilterRuleProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnBucket.S3KeyFilterProperty.Builder A builder for CfnBucket.S3KeyFilterProperty
static class	CfnBucket.S3KeyFilterProperty.Jsii$Proxy An implementation for CfnBucket.S3KeyFilterProperty

Method Summary

Modifier and Type	Method and Description
static CfnBucket.S3KeyFilterProperty.Builder	builder()
Object	getRules() A list of containers for the key-value pair that defines the criteria for the filter rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRules

@Stability(value=Stable)
 @NotNull
Object getRules()

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

builder

@Stability(value=Stable)
static CfnBucket.S3KeyFilterProperty.Builder builder()

Returns:

a CfnBucket.S3KeyFilterProperty.Builder of CfnBucket.S3KeyFilterProperty