aws-cdk-lib.aws_s3.CfnStorageLensProps

interface CfnStorageLensProps

LanguageType name
.NETAmazon.CDK.AWS.S3.CfnStorageLensProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnStorageLensProps
Javasoftware.amazon.awscdk.services.s3.CfnStorageLensProps
Pythonaws_cdk.aws_s3.CfnStorageLensProps
TypeScript aws-cdk-lib » aws_s3 » CfnStorageLensProps

Properties for defining a CfnStorageLens.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';

declare const sses3: any;
const cfnStorageLensProps: s3.CfnStorageLensProps = {
  storageLensConfiguration: {
    accountLevel: {
      bucketLevel: {
        activityMetrics: {
          isEnabled: false,
        },
        advancedCostOptimizationMetrics: {
          isEnabled: false,
        },
        advancedDataProtectionMetrics: {
          isEnabled: false,
        },
        detailedStatusCodesMetrics: {
          isEnabled: false,
        },
        prefixLevel: {
          storageMetrics: {
            isEnabled: false,
            selectionCriteria: {
              delimiter: 'delimiter',
              maxDepth: 123,
              minStorageBytesPercentage: 123,
            },
          },
        },
      },

      // the properties below are optional
      activityMetrics: {
        isEnabled: false,
      },
      advancedCostOptimizationMetrics: {
        isEnabled: false,
      },
      advancedDataProtectionMetrics: {
        isEnabled: false,
      },
      detailedStatusCodesMetrics: {
        isEnabled: false,
      },
    },
    id: 'id',
    isEnabled: false,

    // the properties below are optional
    awsOrg: {
      arn: 'arn',
    },
    dataExport: {
      cloudWatchMetrics: {
        isEnabled: false,
      },
      s3BucketDestination: {
        accountId: 'accountId',
        arn: 'arn',
        format: 'format',
        outputSchemaVersion: 'outputSchemaVersion',

        // the properties below are optional
        encryption: {
          ssekms: {
            keyId: 'keyId',
          },
          sses3: sses3,
        },
        prefix: 'prefix',
      },
    },
    exclude: {
      buckets: ['buckets'],
      regions: ['regions'],
    },
    include: {
      buckets: ['buckets'],
      regions: ['regions'],
    },
    storageLensArn: 'storageLensArn',
  },

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
storageLensConfigurationIResolvable | StorageLensConfigurationPropertyThis resource contains the details Amazon S3 Storage Lens configuration.
tags?CfnTag[]A set of tags (key–value pairs) to associate with the Storage Lens configuration.

storageLensConfiguration

Type: IResolvable | StorageLensConfigurationProperty

This resource contains the details Amazon S3 Storage Lens configuration.


tags?

Type: CfnTag[] (optional)

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