CfnStorageLensPropsMixin

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

Bases: Mixin

The AWS::S3::StorageLens resource creates an Amazon S3 Storage Lens configuration.

See:

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

CloudformationResource:

AWS::S3::StorageLens

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

# sses3: Any

cfn_storage_lens_props_mixin = s3_mixins.CfnStorageLensPropsMixin(s3_mixins.CfnStorageLensMixinProps(
    storage_lens_configuration=s3_mixins.CfnStorageLensPropsMixin.StorageLensConfigurationProperty(
        account_level=s3_mixins.CfnStorageLensPropsMixin.AccountLevelProperty(
            activity_metrics=s3_mixins.CfnStorageLensPropsMixin.ActivityMetricsProperty(
                is_enabled=False
            ),
            advanced_cost_optimization_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(
                is_enabled=False
            ),
            advanced_data_protection_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(
                is_enabled=False
            ),
            bucket_level=s3_mixins.CfnStorageLensPropsMixin.BucketLevelProperty(
                activity_metrics=s3_mixins.CfnStorageLensPropsMixin.ActivityMetricsProperty(
                    is_enabled=False
                ),
                advanced_cost_optimization_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(
                    is_enabled=False
                ),
                advanced_data_protection_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(
                    is_enabled=False
                ),
                detailed_status_codes_metrics=s3_mixins.CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(
                    is_enabled=False
                ),
                prefix_level=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelProperty(
                    storage_metrics=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelStorageMetricsProperty(
                        is_enabled=False,
                        selection_criteria=s3_mixins.CfnStorageLensPropsMixin.SelectionCriteriaProperty(
                            delimiter="delimiter",
                            max_depth=123,
                            min_storage_bytes_percentage=123
                        )
                    )
                )
            ),
            detailed_status_codes_metrics=s3_mixins.CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(
                is_enabled=False
            ),
            storage_lens_group_level=s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupLevelProperty(
                storage_lens_group_selection_criteria=s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupSelectionCriteriaProperty(
                    exclude=["exclude"],
                    include=["include"]
                )
            )
        ),
        aws_org=s3_mixins.CfnStorageLensPropsMixin.AwsOrgProperty(
            arn="arn"
        ),
        data_export=s3_mixins.CfnStorageLensPropsMixin.DataExportProperty(
            cloud_watch_metrics=s3_mixins.CfnStorageLensPropsMixin.CloudWatchMetricsProperty(
                is_enabled=False
            ),
            s3_bucket_destination=s3_mixins.CfnStorageLensPropsMixin.S3BucketDestinationProperty(
                account_id="accountId",
                arn="arn",
                encryption=s3_mixins.CfnStorageLensPropsMixin.EncryptionProperty(
                    ssekms=s3_mixins.CfnStorageLensPropsMixin.SSEKMSProperty(
                        key_id="keyId"
                    ),
                    sses3=sses3
                ),
                format="format",
                output_schema_version="outputSchemaVersion",
                prefix="prefix"
            )
        ),
        exclude=s3_mixins.CfnStorageLensPropsMixin.BucketsAndRegionsProperty(
            buckets=["buckets"],
            regions=["regions"]
        ),
        id="id",
        include=s3_mixins.CfnStorageLensPropsMixin.BucketsAndRegionsProperty(
            buckets=["buckets"],
            regions=["regions"]
        ),
        is_enabled=False,
        storage_lens_arn="storageLensArn"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

  • props (Union[CfnStorageLensMixinProps, 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 = ['storageLensConfiguration', '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

AccountLevelProperty

class CfnStorageLensPropsMixin.AccountLevelProperty(*, activity_metrics=None, advanced_cost_optimization_metrics=None, advanced_data_protection_metrics=None, bucket_level=None, detailed_status_codes_metrics=None, storage_lens_group_level=None)

Bases: object

This resource contains the details of the account-level metrics for Amazon S3 Storage Lens.

Parameters:

  • activity_metrics (Union[IResolvable, ActivityMetricsProperty, Dict[str, Any], None]) – This property contains the details of account-level activity metrics for S3 Storage Lens.

  • advanced_cost_optimization_metrics (Union[IResolvable, AdvancedCostOptimizationMetricsProperty, Dict[str, Any], None]) – This property contains the details of account-level advanced cost optimization metrics for S3 Storage Lens.

  • advanced_data_protection_metrics (Union[IResolvable, AdvancedDataProtectionMetricsProperty, Dict[str, Any], None]) – This property contains the details of account-level advanced data protection metrics for S3 Storage Lens.

  • bucket_level (Union[IResolvable, BucketLevelProperty, Dict[str, Any], None]) – This property contains the details of the account-level bucket-level configurations for Amazon S3 Storage Lens. To enable bucket-level configurations, make sure to also set the same metrics at the account level.

  • detailed_status_codes_metrics (Union[IResolvable, DetailedStatusCodesMetricsProperty, Dict[str, Any], None]) – This property contains the details of account-level detailed status code metrics for S3 Storage Lens.

  • storage_lens_group_level (Union[IResolvable, StorageLensGroupLevelProperty, Dict[str, Any], None]) – This property determines the scope of Storage Lens group data that is displayed in the Storage Lens dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.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

account_level_property = s3_mixins.CfnStorageLensPropsMixin.AccountLevelProperty(
    activity_metrics=s3_mixins.CfnStorageLensPropsMixin.ActivityMetricsProperty(
        is_enabled=False
    ),
    advanced_cost_optimization_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(
        is_enabled=False
    ),
    advanced_data_protection_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(
        is_enabled=False
    ),
    bucket_level=s3_mixins.CfnStorageLensPropsMixin.BucketLevelProperty(
        activity_metrics=s3_mixins.CfnStorageLensPropsMixin.ActivityMetricsProperty(
            is_enabled=False
        ),
        advanced_cost_optimization_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(
            is_enabled=False
        ),
        advanced_data_protection_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(
            is_enabled=False
        ),
        detailed_status_codes_metrics=s3_mixins.CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(
            is_enabled=False
        ),
        prefix_level=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelProperty(
            storage_metrics=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelStorageMetricsProperty(
                is_enabled=False,
                selection_criteria=s3_mixins.CfnStorageLensPropsMixin.SelectionCriteriaProperty(
                    delimiter="delimiter",
                    max_depth=123,
                    min_storage_bytes_percentage=123
                )
            )
        )
    ),
    detailed_status_codes_metrics=s3_mixins.CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(
        is_enabled=False
    ),
    storage_lens_group_level=s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupLevelProperty(
        storage_lens_group_selection_criteria=s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupSelectionCriteriaProperty(
            exclude=["exclude"],
            include=["include"]
        )
    )
)

Attributes

activity_metrics

This property contains the details of account-level activity metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-activitymetrics

advanced_cost_optimization_metrics

This property contains the details of account-level advanced cost optimization metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-advancedcostoptimizationmetrics

advanced_data_protection_metrics

This property contains the details of account-level advanced data protection metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-advanceddataprotectionmetrics

bucket_level

This property contains the details of the account-level bucket-level configurations for Amazon S3 Storage Lens.

To enable bucket-level configurations, make sure to also set the same metrics at the account level.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-bucketlevel

detailed_status_codes_metrics

This property contains the details of account-level detailed status code metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-detailedstatuscodesmetrics

storage_lens_group_level

This property determines the scope of Storage Lens group data that is displayed in the Storage Lens dashboard.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-accountlevel.html#cfn-s3-storagelens-accountlevel-storagelensgrouplevel

ActivityMetricsProperty

class CfnStorageLensPropsMixin.ActivityMetricsProperty(*, is_enabled=None)

Bases: object

This resource enables Amazon S3 Storage Lens activity metrics.

Activity metrics show details about how your storage is requested, such as requests (for example, All requests, Get requests, Put requests), bytes uploaded or downloaded, and errors.

For more information, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide . For a complete list of metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide .

Parameters:

is_enabled (Union[bool, IResolvable, None]) – A property that indicates whether the activity metrics is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.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

activity_metrics_property = s3_mixins.CfnStorageLensPropsMixin.ActivityMetricsProperty(
    is_enabled=False
)

Attributes

is_enabled

A property that indicates whether the activity metrics is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-activitymetrics.html#cfn-s3-storagelens-activitymetrics-isenabled

AdvancedCostOptimizationMetricsProperty

class CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(*, is_enabled=None)

Bases: object

This resource enables Amazon S3 Storage Lens advanced cost optimization metrics.

Advanced cost optimization metrics provide insights that you can use to manage and optimize your storage costs, for example, lifecycle rule counts for transitions, expirations, and incomplete multipart uploads.

For more information, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide . For a complete list of metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide .

Parameters:

is_enabled (Union[bool, IResolvable, None]) – Indicates whether advanced cost optimization metrics are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.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

advanced_cost_optimization_metrics_property = s3_mixins.CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(
    is_enabled=False
)

Attributes

is_enabled

Indicates whether advanced cost optimization metrics are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advancedcostoptimizationmetrics.html#cfn-s3-storagelens-advancedcostoptimizationmetrics-isenabled

AdvancedDataProtectionMetricsProperty

class CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(*, is_enabled=None)

Bases: object

This resource enables Amazon S3 Storage Lens advanced data protection metrics.

Advanced data protection metrics provide insights that you can use to perform audits and protect your data, for example replication rule counts within and across Regions.

For more information, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide . For a complete list of metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide .

Parameters:

is_enabled (Union[bool, IResolvable, None]) – Indicates whether advanced data protection metrics are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.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

advanced_data_protection_metrics_property = s3_mixins.CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(
    is_enabled=False
)

Attributes

is_enabled

Indicates whether advanced data protection metrics are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-advanceddataprotectionmetrics.html#cfn-s3-storagelens-advanceddataprotectionmetrics-isenabled

AwsOrgProperty

class CfnStorageLensPropsMixin.AwsOrgProperty(*, arn=None)

Bases: object

This resource contains the details of the AWS Organization for Amazon S3 Storage Lens.

Parameters:

arn (Optional[str]) – This resource contains the ARN of the AWS Organization.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-awsorg.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

aws_org_property = s3_mixins.CfnStorageLensPropsMixin.AwsOrgProperty(
    arn="arn"
)

Attributes

arn

This resource contains the ARN of the AWS Organization.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-awsorg.html#cfn-s3-storagelens-awsorg-arn

BucketLevelProperty

class CfnStorageLensPropsMixin.BucketLevelProperty(*, activity_metrics=None, advanced_cost_optimization_metrics=None, advanced_data_protection_metrics=None, detailed_status_codes_metrics=None, prefix_level=None)

Bases: object

A property for the bucket-level storage metrics for Amazon S3 Storage Lens.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.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

bucket_level_property = s3_mixins.CfnStorageLensPropsMixin.BucketLevelProperty(
    activity_metrics=s3_mixins.CfnStorageLensPropsMixin.ActivityMetricsProperty(
        is_enabled=False
    ),
    advanced_cost_optimization_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(
        is_enabled=False
    ),
    advanced_data_protection_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(
        is_enabled=False
    ),
    detailed_status_codes_metrics=s3_mixins.CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(
        is_enabled=False
    ),
    prefix_level=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelProperty(
        storage_metrics=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelStorageMetricsProperty(
            is_enabled=False,
            selection_criteria=s3_mixins.CfnStorageLensPropsMixin.SelectionCriteriaProperty(
                delimiter="delimiter",
                max_depth=123,
                min_storage_bytes_percentage=123
            )
        )
    )
)

Attributes

activity_metrics

A property for bucket-level activity metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-activitymetrics

advanced_cost_optimization_metrics

A property for bucket-level advanced cost optimization metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-advancedcostoptimizationmetrics

advanced_data_protection_metrics

A property for bucket-level advanced data protection metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-advanceddataprotectionmetrics

detailed_status_codes_metrics

A property for bucket-level detailed status code metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-detailedstatuscodesmetrics

prefix_level

A property for bucket-level prefix-level storage metrics for S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketlevel.html#cfn-s3-storagelens-bucketlevel-prefixlevel

BucketsAndRegionsProperty

class CfnStorageLensPropsMixin.BucketsAndRegionsProperty(*, buckets=None, regions=None)

Bases: object

This resource contains the details of the buckets and Regions for the Amazon S3 Storage Lens configuration.

Parameters:

  • buckets (Optional[Sequence[str]]) – This property contains the details of the buckets for the Amazon S3 Storage Lens configuration. This should be the bucket Amazon Resource Name(ARN). For valid values, see Buckets ARN format here in the Amazon S3 API Reference .

  • regions (Optional[Sequence[str]]) – This property contains the details of the Regions for the S3 Storage Lens configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.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

buckets_and_regions_property = s3_mixins.CfnStorageLensPropsMixin.BucketsAndRegionsProperty(
    buckets=["buckets"],
    regions=["regions"]
)

Attributes

buckets

This property contains the details of the buckets for the Amazon S3 Storage Lens configuration.

This should be the bucket Amazon Resource Name(ARN). For valid values, see Buckets ARN format here in the Amazon S3 API Reference .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html#cfn-s3-storagelens-bucketsandregions-buckets

regions

This property contains the details of the Regions for the S3 Storage Lens configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-bucketsandregions.html#cfn-s3-storagelens-bucketsandregions-regions

CloudWatchMetricsProperty

class CfnStorageLensPropsMixin.CloudWatchMetricsProperty(*, is_enabled=None)

Bases: object

This resource enables the Amazon CloudWatch publishing option for Amazon S3 Storage Lens metrics.

For more information, see Monitor S3 Storage Lens metrics in CloudWatch in the Amazon S3 User Guide .

Parameters:

is_enabled (Union[bool, IResolvable, None]) – This property identifies whether the CloudWatch publishing option for S3 Storage Lens is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-cloudwatchmetrics.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

cloud_watch_metrics_property = s3_mixins.CfnStorageLensPropsMixin.CloudWatchMetricsProperty(
    is_enabled=False
)

Attributes

is_enabled

This property identifies whether the CloudWatch publishing option for S3 Storage Lens is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-cloudwatchmetrics.html#cfn-s3-storagelens-cloudwatchmetrics-isenabled

DataExportProperty

class CfnStorageLensPropsMixin.DataExportProperty(*, cloud_watch_metrics=None, s3_bucket_destination=None)

Bases: object

This resource contains the details of the Amazon S3 Storage Lens metrics export.

Parameters:

  • cloud_watch_metrics (Union[IResolvable, CloudWatchMetricsProperty, Dict[str, Any], None]) – This property enables the Amazon CloudWatch publishing option for S3 Storage Lens metrics.

  • s3_bucket_destination (Union[IResolvable, S3BucketDestinationProperty, Dict[str, Any], None]) – This property contains the details of the bucket where the S3 Storage Lens metrics export will be placed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.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

# sses3: Any

data_export_property = s3_mixins.CfnStorageLensPropsMixin.DataExportProperty(
    cloud_watch_metrics=s3_mixins.CfnStorageLensPropsMixin.CloudWatchMetricsProperty(
        is_enabled=False
    ),
    s3_bucket_destination=s3_mixins.CfnStorageLensPropsMixin.S3BucketDestinationProperty(
        account_id="accountId",
        arn="arn",
        encryption=s3_mixins.CfnStorageLensPropsMixin.EncryptionProperty(
            ssekms=s3_mixins.CfnStorageLensPropsMixin.SSEKMSProperty(
                key_id="keyId"
            ),
            sses3=sses3
        ),
        format="format",
        output_schema_version="outputSchemaVersion",
        prefix="prefix"
    )
)

Attributes

cloud_watch_metrics

This property enables the Amazon CloudWatch publishing option for S3 Storage Lens metrics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html#cfn-s3-storagelens-dataexport-cloudwatchmetrics

s3_bucket_destination

This property contains the details of the bucket where the S3 Storage Lens metrics export will be placed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-dataexport.html#cfn-s3-storagelens-dataexport-s3bucketdestination

DetailedStatusCodesMetricsProperty

class CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(*, is_enabled=None)

Bases: object

This resource enables Amazon S3 Storage Lens detailed status code metrics.

Detailed status code metrics generate metrics for HTTP status codes, such as 200 OK , 403 Forbidden , 503 Service Unavailable and others.

For more information, see Assessing your storage activity and usage with S3 Storage Lens in the Amazon S3 User Guide . For a complete list of metrics, see S3 Storage Lens metrics glossary in the Amazon S3 User Guide .

Parameters:

is_enabled (Union[bool, IResolvable, None]) – Indicates whether detailed status code metrics are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.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

detailed_status_codes_metrics_property = s3_mixins.CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(
    is_enabled=False
)

Attributes

is_enabled

Indicates whether detailed status code metrics are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-detailedstatuscodesmetrics.html#cfn-s3-storagelens-detailedstatuscodesmetrics-isenabled

EncryptionProperty

class CfnStorageLensPropsMixin.EncryptionProperty(*, ssekms=None, sses3=None)

Bases: object

This resource contains the type of server-side encryption used to encrypt an Amazon S3 Storage Lens metrics export.

For valid values, see the StorageLensDataExportEncryption in the Amazon S3 API Reference .

Parameters:

  • ssekms (Union[IResolvable, SSEKMSProperty, Dict[str, Any], None]) – Specifies the use of AWS Key Management Service keys (SSE-KMS) to encrypt the S3 Storage Lens metrics export file.

  • sses3 (Any) – Specifies the use of an Amazon S3-managed key (SSE-S3) to encrypt the S3 Storage Lens metrics export file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-encryption.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

# sses3: Any

encryption_property = s3_mixins.CfnStorageLensPropsMixin.EncryptionProperty(
    ssekms=s3_mixins.CfnStorageLensPropsMixin.SSEKMSProperty(
        key_id="keyId"
    ),
    sses3=sses3
)

Attributes

ssekms

Specifies the use of AWS Key Management Service keys (SSE-KMS) to encrypt the S3 Storage Lens metrics export file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-encryption.html#cfn-s3-storagelens-encryption-ssekms

sses3

Specifies the use of an Amazon S3-managed key (SSE-S3) to encrypt the S3 Storage Lens metrics export file.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-encryption.html#cfn-s3-storagelens-encryption-sses3

PrefixLevelProperty

class CfnStorageLensPropsMixin.PrefixLevelProperty(*, storage_metrics=None)

Bases: object

This resource contains the details of the prefix-level of the Amazon S3 Storage Lens.

Parameters:

storage_metrics (Union[IResolvable, PrefixLevelStorageMetricsProperty, Dict[str, Any], None]) – A property for the prefix-level storage metrics for Amazon S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.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

prefix_level_property = s3_mixins.CfnStorageLensPropsMixin.PrefixLevelProperty(
    storage_metrics=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelStorageMetricsProperty(
        is_enabled=False,
        selection_criteria=s3_mixins.CfnStorageLensPropsMixin.SelectionCriteriaProperty(
            delimiter="delimiter",
            max_depth=123,
            min_storage_bytes_percentage=123
        )
    )
)

Attributes

storage_metrics

A property for the prefix-level storage metrics for Amazon S3 Storage Lens.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevel.html#cfn-s3-storagelens-prefixlevel-storagemetrics

PrefixLevelStorageMetricsProperty

class CfnStorageLensPropsMixin.PrefixLevelStorageMetricsProperty(*, is_enabled=None, selection_criteria=None)

Bases: object

This resource contains the details of the prefix-level storage metrics for Amazon S3 Storage Lens.

Parameters:

  • is_enabled (Union[bool, IResolvable, None]) – This property identifies whether the details of the prefix-level storage metrics for S3 Storage Lens are enabled.

  • selection_criteria (Union[IResolvable, SelectionCriteriaProperty, Dict[str, Any], None]) – This property identifies whether the details of the prefix-level storage metrics for S3 Storage Lens are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.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

prefix_level_storage_metrics_property = s3_mixins.CfnStorageLensPropsMixin.PrefixLevelStorageMetricsProperty(
    is_enabled=False,
    selection_criteria=s3_mixins.CfnStorageLensPropsMixin.SelectionCriteriaProperty(
        delimiter="delimiter",
        max_depth=123,
        min_storage_bytes_percentage=123
    )
)

Attributes

is_enabled

This property identifies whether the details of the prefix-level storage metrics for S3 Storage Lens are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html#cfn-s3-storagelens-prefixlevelstoragemetrics-isenabled

selection_criteria

This property identifies whether the details of the prefix-level storage metrics for S3 Storage Lens are enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-prefixlevelstoragemetrics.html#cfn-s3-storagelens-prefixlevelstoragemetrics-selectioncriteria

S3BucketDestinationProperty

class CfnStorageLensPropsMixin.S3BucketDestinationProperty(*, account_id=None, arn=None, encryption=None, format=None, output_schema_version=None, prefix=None)

Bases: object

This resource contains the details of the bucket where the Amazon S3 Storage Lens metrics export will be placed.

Parameters:

  • account_id (Optional[str]) – This property contains the details of the AWS account ID of the S3 Storage Lens export bucket destination.

  • arn (Optional[str]) – This property contains the details of the ARN of the bucket destination of the S3 Storage Lens export.

  • encryption (Union[IResolvable, EncryptionProperty, Dict[str, Any], None]) – This property contains the details of the encryption of the bucket destination of the Amazon S3 Storage Lens metrics export.

  • format (Optional[str]) – This property contains the details of the format of the S3 Storage Lens export bucket destination.

  • output_schema_version (Optional[str]) – This property contains the details of the output schema version of the S3 Storage Lens export bucket destination.

  • prefix (Optional[str]) – This property contains the details of the prefix of the bucket destination of the S3 Storage Lens export .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.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

# sses3: Any

s3_bucket_destination_property = s3_mixins.CfnStorageLensPropsMixin.S3BucketDestinationProperty(
    account_id="accountId",
    arn="arn",
    encryption=s3_mixins.CfnStorageLensPropsMixin.EncryptionProperty(
        ssekms=s3_mixins.CfnStorageLensPropsMixin.SSEKMSProperty(
            key_id="keyId"
        ),
        sses3=sses3
    ),
    format="format",
    output_schema_version="outputSchemaVersion",
    prefix="prefix"
)

Attributes

account_id

This property contains the details of the AWS account ID of the S3 Storage Lens export bucket destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-accountid

arn

This property contains the details of the ARN of the bucket destination of the S3 Storage Lens export.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-arn

encryption

This property contains the details of the encryption of the bucket destination of the Amazon S3 Storage Lens metrics export.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-encryption

format

This property contains the details of the format of the S3 Storage Lens export bucket destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-format

output_schema_version

This property contains the details of the output schema version of the S3 Storage Lens export bucket destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-outputschemaversion

prefix

This property contains the details of the prefix of the bucket destination of the S3 Storage Lens export .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-s3bucketdestination.html#cfn-s3-storagelens-s3bucketdestination-prefix

SSEKMSProperty

class CfnStorageLensPropsMixin.SSEKMSProperty(*, key_id=None)

Bases: object

Specifies the use of server-side encryption using an AWS Key Management Service key (SSE-KMS) to encrypt the delivered S3 Storage Lens metrics export file.

Parameters:

key_id (Optional[str]) – Specifies the Amazon Resource Name (ARN) of the customer managed AWS key to use for encrypting the S3 Storage Lens metrics export file. Amazon S3 only supports symmetric encryption keys. For more information, see Special-purpose keys in the AWS Key Management Service Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.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

s_sEKMSProperty = s3_mixins.CfnStorageLensPropsMixin.SSEKMSProperty(
    key_id="keyId"
)

Attributes

key_id

Specifies the Amazon Resource Name (ARN) of the customer managed AWS key to use for encrypting the S3 Storage Lens metrics export file.

Amazon S3 only supports symmetric encryption keys. For more information, see Special-purpose keys in the AWS Key Management Service Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-ssekms.html#cfn-s3-storagelens-ssekms-keyid

SelectionCriteriaProperty

class CfnStorageLensPropsMixin.SelectionCriteriaProperty(*, delimiter=None, max_depth=None, min_storage_bytes_percentage=None)

Bases: object

This resource contains the details of the Amazon S3 Storage Lens selection criteria.

Parameters:

  • delimiter (Optional[str]) – This property contains the details of the S3 Storage Lens delimiter being used.

  • max_depth (Union[int, float, None]) – This property contains the details of the max depth that S3 Storage Lens will collect metrics up to.

  • min_storage_bytes_percentage (Union[int, float, None]) – This property contains the details of the minimum storage bytes percentage threshold that S3 Storage Lens will collect metrics up to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.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

selection_criteria_property = s3_mixins.CfnStorageLensPropsMixin.SelectionCriteriaProperty(
    delimiter="delimiter",
    max_depth=123,
    min_storage_bytes_percentage=123
)

Attributes

delimiter

This property contains the details of the S3 Storage Lens delimiter being used.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-delimiter

max_depth

This property contains the details of the max depth that S3 Storage Lens will collect metrics up to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-maxdepth

min_storage_bytes_percentage

This property contains the details of the minimum storage bytes percentage threshold that S3 Storage Lens will collect metrics up to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-selectioncriteria.html#cfn-s3-storagelens-selectioncriteria-minstoragebytespercentage

StorageLensConfigurationProperty

class CfnStorageLensPropsMixin.StorageLensConfigurationProperty(*, account_level=None, aws_org=None, data_export=None, exclude=None, id=None, include=None, is_enabled=None, storage_lens_arn=None)

Bases: object

This is the property of the Amazon S3 Storage Lens configuration.

Parameters:

  • account_level (Union[IResolvable, AccountLevelProperty, Dict[str, Any], None]) – This property contains the details of the account-level metrics for Amazon S3 Storage Lens configuration.

  • aws_org (Union[IResolvable, AwsOrgProperty, Dict[str, Any], None]) – This property contains the details of the AWS Organization for the S3 Storage Lens configuration.

  • data_export (Union[IResolvable, DataExportProperty, Dict[str, Any], None]) – This property contains the details of this S3 Storage Lens configuration’s metrics export.

  • exclude (Union[IResolvable, BucketsAndRegionsProperty, Dict[str, Any], None]) – This property contains the details of the bucket and or Regions excluded for Amazon S3 Storage Lens configuration.

  • id (Optional[str]) – This property contains the details of the ID of the S3 Storage Lens configuration.

  • include (Union[IResolvable, BucketsAndRegionsProperty, Dict[str, Any], None]) – This property contains the details of the bucket and or Regions included for Amazon S3 Storage Lens configuration.

  • is_enabled (Union[bool, IResolvable, None]) – This property contains the details of whether the Amazon S3 Storage Lens configuration is enabled.

  • storage_lens_arn (Optional[str]) – This property contains the details of the ARN of the S3 Storage Lens configuration. This property is read-only.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensconfiguration.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

# sses3: Any

storage_lens_configuration_property = s3_mixins.CfnStorageLensPropsMixin.StorageLensConfigurationProperty(
    account_level=s3_mixins.CfnStorageLensPropsMixin.AccountLevelProperty(
        activity_metrics=s3_mixins.CfnStorageLensPropsMixin.ActivityMetricsProperty(
            is_enabled=False
        ),
        advanced_cost_optimization_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(
            is_enabled=False
        ),
        advanced_data_protection_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(
            is_enabled=False
        ),
        bucket_level=s3_mixins.CfnStorageLensPropsMixin.BucketLevelProperty(
            activity_metrics=s3_mixins.CfnStorageLensPropsMixin.ActivityMetricsProperty(
                is_enabled=False
            ),
            advanced_cost_optimization_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedCostOptimizationMetricsProperty(
                is_enabled=False
            ),
            advanced_data_protection_metrics=s3_mixins.CfnStorageLensPropsMixin.AdvancedDataProtectionMetricsProperty(
                is_enabled=False
            ),
            detailed_status_codes_metrics=s3_mixins.CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(
                is_enabled=False
            ),
            prefix_level=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelProperty(
                storage_metrics=s3_mixins.CfnStorageLensPropsMixin.PrefixLevelStorageMetricsProperty(
                    is_enabled=False,
                    selection_criteria=s3_mixins.CfnStorageLensPropsMixin.SelectionCriteriaProperty(
                        delimiter="delimiter",
                        max_depth=123,
                        min_storage_bytes_percentage=123
                    )
                )
            )
        ),
        detailed_status_codes_metrics=s3_mixins.CfnStorageLensPropsMixin.DetailedStatusCodesMetricsProperty(
            is_enabled=False
        ),
        storage_lens_group_level=s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupLevelProperty(
            storage_lens_group_selection_criteria=s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupSelectionCriteriaProperty(
                exclude=["exclude"],
                include=["include"]
            )
        )
    ),
    aws_org=s3_mixins.CfnStorageLensPropsMixin.AwsOrgProperty(
        arn="arn"
    ),
    data_export=s3_mixins.CfnStorageLensPropsMixin.DataExportProperty(
        cloud_watch_metrics=s3_mixins.CfnStorageLensPropsMixin.CloudWatchMetricsProperty(
            is_enabled=False
        ),
        s3_bucket_destination=s3_mixins.CfnStorageLensPropsMixin.S3BucketDestinationProperty(
            account_id="accountId",
            arn="arn",
            encryption=s3_mixins.CfnStorageLensPropsMixin.EncryptionProperty(
                ssekms=s3_mixins.CfnStorageLensPropsMixin.SSEKMSProperty(
                    key_id="keyId"
                ),
                sses3=sses3
            ),
            format="format",
            output_schema_version="outputSchemaVersion",
            prefix="prefix"
        )
    ),
    exclude=s3_mixins.CfnStorageLensPropsMixin.BucketsAndRegionsProperty(
        buckets=["buckets"],
        regions=["regions"]
    ),
    id="id",
    include=s3_mixins.CfnStorageLensPropsMixin.BucketsAndRegionsProperty(
        buckets=["buckets"],
        regions=["regions"]
    ),
    is_enabled=False,
    storage_lens_arn="storageLensArn"
)

Attributes

account_level

This property contains the details of the account-level metrics for Amazon S3 Storage Lens configuration.

See:

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

aws_org

This property contains the details of the AWS Organization for the S3 Storage Lens configuration.

See:

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

data_export

This property contains the details of this S3 Storage Lens configuration’s metrics export.

See:

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

exclude

This property contains the details of the bucket and or Regions excluded for Amazon S3 Storage Lens configuration.

See:

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

id

This property contains the details of the ID of the S3 Storage Lens configuration.

See:

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

include

This property contains the details of the bucket and or Regions included for Amazon S3 Storage Lens configuration.

See:

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

is_enabled

This property contains the details of whether the Amazon S3 Storage Lens configuration is enabled.

See:

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

storage_lens_arn

This property contains the details of the ARN of the S3 Storage Lens configuration.

This property is read-only.

See:

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

StorageLensGroupLevelProperty

class CfnStorageLensPropsMixin.StorageLensGroupLevelProperty(*, storage_lens_group_selection_criteria=None)

Bases: object

This resource determines the scope of Storage Lens group data that is displayed in the Storage Lens dashboard.

Parameters:

storage_lens_group_selection_criteria (Union[IResolvable, StorageLensGroupSelectionCriteriaProperty, Dict[str, Any], None]) – This property indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgrouplevel.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

storage_lens_group_level_property = s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupLevelProperty(
    storage_lens_group_selection_criteria=s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupSelectionCriteriaProperty(
        exclude=["exclude"],
        include=["include"]
    )
)

Attributes

storage_lens_group_selection_criteria

This property indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation.

If this value is left null, then all Storage Lens groups are selected.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgrouplevel.html#cfn-s3-storagelens-storagelensgrouplevel-storagelensgroupselectioncriteria

StorageLensGroupSelectionCriteriaProperty

class CfnStorageLensPropsMixin.StorageLensGroupSelectionCriteriaProperty(*, exclude=None, include=None)

Bases: object

This resource indicates which Storage Lens group ARNs to include or exclude in the Storage Lens group aggregation.

You can only attach Storage Lens groups to your dashboard if they’re included in your Storage Lens group aggregation. If this value is left null, then all Storage Lens groups are selected.

Parameters:

  • exclude (Optional[Sequence[str]]) – This property indicates which Storage Lens group ARNs to exclude from the Storage Lens group aggregation.

  • include (Optional[Sequence[str]]) – This property indicates which Storage Lens group ARNs to include in the Storage Lens group aggregation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.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

storage_lens_group_selection_criteria_property = s3_mixins.CfnStorageLensPropsMixin.StorageLensGroupSelectionCriteriaProperty(
    exclude=["exclude"],
    include=["include"]
)

Attributes

exclude

This property indicates which Storage Lens group ARNs to exclude from the Storage Lens group aggregation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html#cfn-s3-storagelens-storagelensgroupselectioncriteria-exclude

include

This property indicates which Storage Lens group ARNs to include in the Storage Lens group aggregation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-storagelens-storagelensgroupselectioncriteria.html#cfn-s3-storagelens-storagelensgroupselectioncriteria-include