Package software.amazon.awscdk.services.s3

Interface CfnBucket.ReplicationRuleFilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.ReplicationRuleFilterProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.ReplicationRuleFilterProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.s3.*;
 ReplicationRuleFilterProperty replicationRuleFilterProperty = ReplicationRuleFilterProperty.builder()
         .and(ReplicationRuleAndOperatorProperty.builder()
                 .prefix("prefix")
                 .tagFilters(List.of(TagFilterProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .prefix("prefix")
         .tagFilter(TagFilterProperty.builder()
                 .key("key")
                 .value("value")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBucket.ReplicationRuleFilterProperty.Builder	builder()
default Object	getAnd()	A container for specifying rule filters.
default String	getPrefix()	An object key name prefix that identifies the subset of objects to which the rule applies.
default Object	getTagFilter()	A container for specifying a tag key and value.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAnd

@Stability(Stable)
@Nullable
default Object getAnd()

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.

Returns union: either IResolvable or CfnBucket.ReplicationRuleAndOperatorProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-and

getPrefix

@Stability(Stable)
@Nullable
default String getPrefix()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-prefix

getTagFilter

@Stability(Stable)
@Nullable
default Object getTagFilter()

A container for specifying a tag key and value.

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

Returns union: either IResolvable or CfnBucket.TagFilterProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-replicationrulefilter.html#cfn-s3-bucket-replicationrulefilter-tagfilter

builder

@Stability(Stable)
static CfnBucket.ReplicationRuleFilterProperty.Builder builder()

Returns:

a CfnBucket.ReplicationRuleFilterProperty.Builder of CfnBucket.ReplicationRuleFilterProperty