CfnStorageLensGroup

class aws_cdk.aws_s3.CfnStorageLensGroup(scope, id, *, filter, name, tags=None)

Bases: CfnResource

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

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 import aws_s3 as s3

cfn_storage_lens_group = s3.CfnStorageLensGroup(self, "MyCfnStorageLensGroup",
    filter=s3.CfnStorageLensGroup.FilterProperty(
        and=s3.CfnStorageLensGroup.AndProperty(
            match_any_prefix=["matchAnyPrefix"],
            match_any_suffix=["matchAnySuffix"],
            match_any_tag=[CfnTag(
                key="key",
                value="value"
            )],
            match_object_age=s3.CfnStorageLensGroup.MatchObjectAgeProperty(
                days_greater_than=123,
                days_less_than=123
            ),
            match_object_size=s3.CfnStorageLensGroup.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.CfnStorageLensGroup.MatchObjectAgeProperty(
            days_greater_than=123,
            days_less_than=123
        ),
        match_object_size=s3.CfnStorageLensGroup.MatchObjectSizeProperty(
            bytes_greater_than=123,
            bytes_less_than=123
        ),
        or=s3.CfnStorageLensGroup.OrProperty(
            match_any_prefix=["matchAnyPrefix"],
            match_any_suffix=["matchAnySuffix"],
            match_any_tag=[CfnTag(
                key="key",
                value="value"
            )],
            match_object_age=s3.CfnStorageLensGroup.MatchObjectAgeProperty(
                days_greater_than=123,
                days_less_than=123
            ),
            match_object_size=s3.CfnStorageLensGroup.MatchObjectSizeProperty(
                bytes_greater_than=123,
                bytes_less_than=123
            )
        )
    ),
    name="name",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
Parameters:
  • scope (Construct) – Scope in which this resource is defined.

  • id (str) – Construct identifier for this resource (unique in its scope).

  • filter (Union[IResolvable, FilterProperty, Dict[str, Any]]) – This property contains the criteria for the Storage Lens group data that is displayed.

  • name (str) – This property contains the Storage Lens group name.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – This property contains the AWS resource tags that you’re adding to your Storage Lens group. This parameter is optional.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:
  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:

List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::S3::StorageLensGroup'
attr_storage_lens_group_arn

The ARN for the Amazon S3 Storage Lens Group.

CloudformationAttribute:

StorageLensGroupArn

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

filter

This property contains the criteria for the Storage Lens group data that is displayed.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

This property contains the Storage Lens group name.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

This property contains the AWS resource tags that you’re adding to your Storage Lens group.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

AndProperty

class CfnStorageLensGroup.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 import aws_s3 as s3

and_property = s3.CfnStorageLensGroup.AndProperty(
    match_any_prefix=["matchAnyPrefix"],
    match_any_suffix=["matchAnySuffix"],
    match_any_tag=[CfnTag(
        key="key",
        value="value"
    )],
    match_object_age=s3.CfnStorageLensGroup.MatchObjectAgeProperty(
        days_greater_than=123,
        days_less_than=123
    ),
    match_object_size=s3.CfnStorageLensGroup.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 CfnStorageLensGroup.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 import aws_s3 as s3

filter_property = s3.CfnStorageLensGroup.FilterProperty(
    and=s3.CfnStorageLensGroup.AndProperty(
        match_any_prefix=["matchAnyPrefix"],
        match_any_suffix=["matchAnySuffix"],
        match_any_tag=[CfnTag(
            key="key",
            value="value"
        )],
        match_object_age=s3.CfnStorageLensGroup.MatchObjectAgeProperty(
            days_greater_than=123,
            days_less_than=123
        ),
        match_object_size=s3.CfnStorageLensGroup.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.CfnStorageLensGroup.MatchObjectAgeProperty(
        days_greater_than=123,
        days_less_than=123
    ),
    match_object_size=s3.CfnStorageLensGroup.MatchObjectSizeProperty(
        bytes_greater_than=123,
        bytes_less_than=123
    ),
    or=s3.CfnStorageLensGroup.OrProperty(
        match_any_prefix=["matchAnyPrefix"],
        match_any_suffix=["matchAnySuffix"],
        match_any_tag=[CfnTag(
            key="key",
            value="value"
        )],
        match_object_age=s3.CfnStorageLensGroup.MatchObjectAgeProperty(
            days_greater_than=123,
            days_less_than=123
        ),
        match_object_size=s3.CfnStorageLensGroup.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 CfnStorageLensGroup.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 import aws_s3 as s3

match_object_age_property = s3.CfnStorageLensGroup.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 CfnStorageLensGroup.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 import aws_s3 as s3

match_object_size_property = s3.CfnStorageLensGroup.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 CfnStorageLensGroup.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 import aws_s3 as s3

or_property = s3.CfnStorageLensGroup.OrProperty(
    match_any_prefix=["matchAnyPrefix"],
    match_any_suffix=["matchAnySuffix"],
    match_any_tag=[CfnTag(
        key="key",
        value="value"
    )],
    match_object_age=s3.CfnStorageLensGroup.MatchObjectAgeProperty(
        days_greater_than=123,
        days_less_than=123
    ),
    match_object_size=s3.CfnStorageLensGroup.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-or.html#cfn-s3-storagelensgroup-or-matchanyprefix

match_any_suffix

This property contains the 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-or.html#cfn-s3-storagelensgroup-or-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-or.html#cfn-s3-storagelensgroup-or-matchanytag

match_object_age

This property filters objects that match the specified object age range.

See:

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

match_object_size

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#cfn-s3-storagelensgroup-or-matchobjectsize