CfnStorageLensProps

class aws_cdk.aws_s3.CfnStorageLensProps(*, storage_lens_configuration, tags=None)

Bases: object

Properties for defining a CfnStorageLens.

Parameters
  • storage_lens_configuration (Union[IResolvable, StorageLensConfigurationProperty, Dict[str, Any]]) – This resource contains the details Amazon S3 Storage Lens configuration.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A set of tags (key–value pairs) to associate with the Storage Lens configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html

ExampleMetadata

fixture=_generated

Example:

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

# encryption: Any

cfn_storage_lens_props = s3.CfnStorageLensProps(
    storage_lens_configuration=s3.CfnStorageLens.StorageLensConfigurationProperty(
        account_level=s3.CfnStorageLens.AccountLevelProperty(
            bucket_level=s3.CfnStorageLens.BucketLevelProperty(
                activity_metrics=s3.CfnStorageLens.ActivityMetricsProperty(
                    is_enabled=False
                ),
                prefix_level=s3.CfnStorageLens.PrefixLevelProperty(
                    storage_metrics=s3.CfnStorageLens.PrefixLevelStorageMetricsProperty(
                        is_enabled=False,
                        selection_criteria=s3.CfnStorageLens.SelectionCriteriaProperty(
                            delimiter="delimiter",
                            max_depth=123,
                            min_storage_bytes_percentage=123
                        )
                    )
                )
            ),

            # the properties below are optional
            activity_metrics=s3.CfnStorageLens.ActivityMetricsProperty(
                is_enabled=False
            )
        ),
        id="id",
        is_enabled=False,

        # the properties below are optional
        aws_org=s3.CfnStorageLens.AwsOrgProperty(
            arn="arn"
        ),
        data_export=s3.CfnStorageLens.DataExportProperty(
            cloud_watch_metrics=s3.CfnStorageLens.CloudWatchMetricsProperty(
                is_enabled=False
            ),
            s3_bucket_destination=s3.CfnStorageLens.S3BucketDestinationProperty(
                account_id="accountId",
                arn="arn",
                format="format",
                output_schema_version="outputSchemaVersion",

                # the properties below are optional
                encryption=encryption,
                prefix="prefix"
            )
        ),
        exclude=s3.CfnStorageLens.BucketsAndRegionsProperty(
            buckets=["buckets"],
            regions=["regions"]
        ),
        include=s3.CfnStorageLens.BucketsAndRegionsProperty(
            buckets=["buckets"],
            regions=["regions"]
        ),
        storage_lens_arn="storageLensArn"
    ),

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

storage_lens_configuration

This resource contains the details Amazon S3 Storage Lens configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#cfn-s3-storagelens-storagelensconfiguration

Return type

Union[IResolvable, StorageLensConfigurationProperty]

tags

A set of tags (key–value pairs) to associate with the Storage Lens configuration.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-storagelens.html#cfn-s3-storagelens-tags

Return type

Optional[List[CfnTag]]