CfnStorageLensGroupPropsMixin

class aws_cdk.mixins_preview.aws_s3.mixins.CfnStorageLensGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::S3::StorageLensGroup resource creates an S3 Storage Lens group.

A Storage Lens group is a custom grouping of objects that include filters for prefixes, suffixes, object tags, object size, or object age. You can create an S3 Storage Lens group that includes a single filter or multiple filter conditions. To specify multiple filter conditions, you use AND or OR logical operators. For more information about S3 Storage Lens groups, see Working with S3 Storage Lens groups .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelensgroup.html
CloudformationResource:: AWS::S3::StorageLensGroup
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_s3 import mixins as s3_mixins

cfn_storage_lens_group_props_mixin = s3_mixins.CfnStorageLensGroupPropsMixin(s3_mixins.CfnStorageLensGroupMixinProps(
    filter=s3_mixins.CfnStorageLensGroupPropsMixin.FilterProperty(
        and=s3_mixins.CfnStorageLensGroupPropsMixin.AndProperty(
            match_any_prefix=["matchAnyPrefix"],
            match_any_suffix=["matchAnySuffix"],
            match_any_tag=[CfnTag(
                key="key",
                value="value"
            )],
            match_object_age=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
                days_greater_than=123,
                days_less_than=123
            ),
            match_object_size=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
                bytes_greater_than=123,
                bytes_less_than=123
            )
        ),
        match_any_prefix=["matchAnyPrefix"],
        match_any_suffix=["matchAnySuffix"],
        match_any_tag=[CfnTag(
            key="key",
            value="value"
        )],
        match_object_age=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
            days_greater_than=123,
            days_less_than=123
        ),
        match_object_size=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
            bytes_greater_than=123,
            bytes_less_than=123
        ),
        or=s3_mixins.CfnStorageLensGroupPropsMixin.OrProperty(
            match_any_prefix=["matchAnyPrefix"],
            match_any_suffix=["matchAnySuffix"],
            match_any_tag=[CfnTag(
                key="key",
                value="value"
            )],
            match_object_age=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
                days_greater_than=123,
                days_less_than=123
            ),
            match_object_size=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
                bytes_greater_than=123,
                bytes_less_than=123
            )
        )
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::S3::StorageLensGroup.

Parameters:

props (Union[CfnStorageLensGroupMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['filter', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AndProperty

class CfnStorageLensGroupPropsMixin.AndProperty(*, match_any_prefix=None, match_any_suffix=None, match_any_tag=None, match_object_age=None, match_object_size=None)

Bases: object

This resource is a logical operator that 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.

Parameters:

match_any_prefix (Optional[Sequence[str]]) – This property contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.
match_any_suffix (Optional[Sequence[str]]) – This property contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.
match_any_tag (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – This property contains the list of object tags. At least one object tag must be specified. Up to 10 object tags are allowed.
match_object_age (Union[IResolvable, MatchObjectAgeProperty, Dict[str, Any], None]) – This property contains DaysGreaterThan and DaysLessThan properties to define the object age range (minimum and maximum number of days).
match_object_size (Union[IResolvable, MatchObjectSizeProperty, Dict[str, Any], None]) – This property contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import mixins as s3_mixins

and_property = s3_mixins.CfnStorageLensGroupPropsMixin.AndProperty(
    match_any_prefix=["matchAnyPrefix"],
    match_any_suffix=["matchAnySuffix"],
    match_any_tag=[CfnTag(
        key="key",
        value="value"
    )],
    match_object_age=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
        days_greater_than=123,
        days_less_than=123
    ),
    match_object_size=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
        bytes_greater_than=123,
        bytes_less_than=123
    )
)

Attributes

match_any_prefix

This property contains a list of prefixes.

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

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

match_any_suffix

This property contains a list of suffixes.

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

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

match_any_tag

This property contains the list of object tags.

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

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

match_object_age

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

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

match_object_size

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

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

FilterProperty

class CfnStorageLensGroupPropsMixin.FilterProperty(*, and_=None, match_any_prefix=None, match_any_suffix=None, match_any_tag=None, match_object_age=None, match_object_size=None, or_=None)

Bases: object

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.

Parameters:

and – 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.
match_any_prefix (Optional[Sequence[str]]) – This property contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.
match_any_suffix (Optional[Sequence[str]]) – This property contains a list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.
match_any_tag (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – This property contains the list of S3 object tags. At least one object tag must be specified. Up to 10 object tags are allowed.
match_object_age (Union[IResolvable, MatchObjectAgeProperty, Dict[str, Any], None]) – This property contains DaysGreaterThan and DaysLessThan to define the object age range (minimum and maximum number of days).
match_object_size (Union[IResolvable, MatchObjectSizeProperty, Dict[str, Any], None]) – This property contains BytesGreaterThan and BytesLessThan to define the object size range (minimum and maximum number of Bytes).
or – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import mixins as s3_mixins

filter_property = s3_mixins.CfnStorageLensGroupPropsMixin.FilterProperty(
    and=s3_mixins.CfnStorageLensGroupPropsMixin.AndProperty(
        match_any_prefix=["matchAnyPrefix"],
        match_any_suffix=["matchAnySuffix"],
        match_any_tag=[CfnTag(
            key="key",
            value="value"
        )],
        match_object_age=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
            days_greater_than=123,
            days_less_than=123
        ),
        match_object_size=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
            bytes_greater_than=123,
            bytes_less_than=123
        )
    ),
    match_any_prefix=["matchAnyPrefix"],
    match_any_suffix=["matchAnySuffix"],
    match_any_tag=[CfnTag(
        key="key",
        value="value"
    )],
    match_object_age=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
        days_greater_than=123,
        days_less_than=123
    ),
    match_object_size=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
        bytes_greater_than=123,
        bytes_less_than=123
    ),
    or=s3_mixins.CfnStorageLensGroupPropsMixin.OrProperty(
        match_any_prefix=["matchAnyPrefix"],
        match_any_suffix=["matchAnySuffix"],
        match_any_tag=[CfnTag(
            key="key",
            value="value"
        )],
        match_object_age=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
            days_greater_than=123,
            days_less_than=123
        ),
        match_object_size=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
            bytes_greater_than=123,
            bytes_less_than=123
        )
    )
)

Attributes

and_

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-and

match_any_prefix

This property contains a list of prefixes.

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

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

match_any_suffix

This property contains a list of suffixes.

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

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

match_any_tag

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-matchanytag

match_object_age

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

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

match_object_size

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

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

or_

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelensgroup-filter.html#cfn-s3-storagelensgroup-filter-or

MatchObjectAgeProperty

class CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(*, days_greater_than=None, days_less_than=None)

Bases: object

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

Parameters:

days_greater_than (Union[int, float, None]) – This property indicates the minimum object age in days.
days_less_than (Union[int, float, None]) – This property indicates the maximum object age in days.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import mixins as s3_mixins

match_object_age_property = s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
    days_greater_than=123,
    days_less_than=123
)

Attributes

days_greater_than

This property indicates the minimum object age in days.

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

days_less_than

This property indicates the maximum object age in days.

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

MatchObjectSizeProperty

class CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(*, bytes_greater_than=None, bytes_less_than=None)

Bases: object

This resource filters objects that match the specified object size range.

Parameters:

bytes_greater_than (Union[int, float, None]) – This property specifies the minimum object size in bytes. The value must be a positive number, greater than 0 and less than 5 TB.
bytes_less_than (Union[int, float, None]) – This property specifies the maximum object size in bytes. The value must be a positive number, greater than the minimum object size and less than 5 TB.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import mixins as s3_mixins

match_object_size_property = s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
    bytes_greater_than=123,
    bytes_less_than=123
)

Attributes

bytes_greater_than

This property specifies the minimum object size in bytes.

The value must be a positive number, greater than 0 and less than 5 TB.

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

bytes_less_than

This property specifies the maximum object size in bytes.

The value must be a positive number, greater than the minimum object size and less than 5 TB.

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

OrProperty

class CfnStorageLensGroupPropsMixin.OrProperty(*, match_any_prefix=None, match_any_suffix=None, match_any_tag=None, match_object_age=None, match_object_size=None)

Bases: object

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

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

Parameters:

match_any_prefix (Optional[Sequence[str]]) – This property contains a list of prefixes. At least one prefix must be specified. Up to 10 prefixes are allowed.
match_any_suffix (Optional[Sequence[str]]) – This property contains the list of suffixes. At least one suffix must be specified. Up to 10 suffixes are allowed.
match_any_tag (Union[IResolvable, Sequence[Union[IResolvable, CfnTag, Dict[str, Any]]], None]) – This property contains the list of S3 object tags. At least one object tag must be specified. Up to 10 object tags are allowed.
match_object_age (Union[IResolvable, MatchObjectAgeProperty, Dict[str, Any], None]) – This property filters objects that match the specified object age range.
match_object_size (Union[IResolvable, MatchObjectSizeProperty, Dict[str, Any], None]) – This property contains the BytesGreaterThan and BytesLessThan values to define the object size range (minimum and maximum number of Bytes).

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_s3 import mixins as s3_mixins

or_property = s3_mixins.CfnStorageLensGroupPropsMixin.OrProperty(
    match_any_prefix=["matchAnyPrefix"],
    match_any_suffix=["matchAnySuffix"],
    match_any_tag=[CfnTag(
        key="key",
        value="value"
    )],
    match_object_age=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectAgeProperty(
        days_greater_than=123,
        days_less_than=123
    ),
    match_object_size=s3_mixins.CfnStorageLensGroupPropsMixin.MatchObjectSizeProperty(
        bytes_greater_than=123,
        bytes_less_than=123
    )
)