Package software.amazon.awscdk.services.s3

Interface CfnStorageLensGroup.FilterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStorageLensGroup.FilterProperty.Jsii$Proxy

Enclosing class:

CfnStorageLensGroup

@Stability(Stable)
public static interface CfnStorageLensGroup.FilterProperty
extends software.amazon.jsii.JsiiSerializable

This resource sets the criteria for the Storage Lens group data that is displayed.

For multiple filter conditions, the AND or OR logical operator is used.

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.*;
 FilterProperty filterProperty = FilterProperty.builder()
         .and(AndProperty.builder()
                 .matchAnyPrefix(List.of("matchAnyPrefix"))
                 .matchAnySuffix(List.of("matchAnySuffix"))
                 .matchAnyTag(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .matchObjectAge(MatchObjectAgeProperty.builder()
                         .daysGreaterThan(123)
                         .daysLessThan(123)
                         .build())
                 .matchObjectSize(MatchObjectSizeProperty.builder()
                         .bytesGreaterThan(123)
                         .bytesLessThan(123)
                         .build())
                 .build())
         .matchAnyPrefix(List.of("matchAnyPrefix"))
         .matchAnySuffix(List.of("matchAnySuffix"))
         .matchAnyTag(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .matchObjectAge(MatchObjectAgeProperty.builder()
                 .daysGreaterThan(123)
                 .daysLessThan(123)
                 .build())
         .matchObjectSize(MatchObjectSizeProperty.builder()
                 .bytesGreaterThan(123)
                 .bytesLessThan(123)
                 .build())
         .or(OrProperty.builder()
                 .matchAnyPrefix(List.of("matchAnyPrefix"))
                 .matchAnySuffix(List.of("matchAnySuffix"))
                 .matchAnyTag(List.of(CfnTag.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .matchObjectAge(MatchObjectAgeProperty.builder()
                         .daysGreaterThan(123)
                         .daysLessThan(123)
                         .build())
                 .matchObjectSize(MatchObjectSizeProperty.builder()
                         .bytesGreaterThan(123)
                         .bytesLessThan(123)
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnStorageLensGroup.FilterProperty.Builder	builder()
default Object	getAnd()	This property contains the And logical operator, which allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data.
default List<String>	getMatchAnyPrefix()	This property contains a list of prefixes.
default List<String>	getMatchAnySuffix()	This property contains a list of suffixes.
default Object	getMatchAnyTag()	This property contains the list of S3 object tags.
default Object	getMatchObjectAge()	This property contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).
default Object	getMatchObjectSize()	This property contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).
default Object	getOr()	This property contains the Or logical operator, which allows multiple filter conditions to be joined.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAnd

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

This property contains the And logical operator, which allows multiple filter conditions to be joined for more complex comparisons of Storage Lens group data.

Objects must match all of the listed filter conditions that are joined by the And logical operator. Only one of each filter condition is allowed.

See Also:

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

getMatchAnyPrefix

@Stability(Stable)
@Nullable
default List<String> getMatchAnyPrefix()

This property contains a list of prefixes.

At least one prefix must be specified. Up to 10 prefixes are allowed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchanyprefix

getMatchAnySuffix

@Stability(Stable)
@Nullable
default List<String> getMatchAnySuffix()

This property contains a list of suffixes.

At least one suffix must be specified. Up to 10 suffixes are allowed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchanysuffix

getMatchAnyTag

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

This property contains the list of S3 object tags.

At least one object tag must be specified. Up to 10 object tags are allowed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchanytag

getMatchObjectAge

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

This property contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchobjectage

getMatchObjectSize

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

This property contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchobjectsize

getOr

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

This property contains the Or logical operator, which allows multiple filter conditions to be joined.

Objects can match any of the listed filter conditions, which are joined by the Or logical operator. Only one of each filter condition is allowed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-or

builder

@Stability(Stable)
static CfnStorageLensGroup.FilterProperty.Builder builder()

Returns:

a CfnStorageLensGroup.FilterProperty.Builder of CfnStorageLensGroup.FilterProperty