AWS CDK Reference

Appearance

v2.274.0

CfnStorageLensProps Struct ​

Properties for defining a CfnStorageLens.

Source
Generated code

Example ​

ts
// 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,
        },
        advancedPerformanceMetrics: {
          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,
      },
      advancedPerformanceMetrics: {
        isEnabled: false,
      },
      detailedStatusCodesMetrics: {
        isEnabled: false,
      },
      storageLensGroupLevel: {
        storageLensGroupSelectionCriteria: {
          exclude: ['exclude'],
          include: ['include'],
        },
      },
    },
    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',
      },
      storageLensTableDestination: {
        isEnabled: false,

        // the properties below are optional
        encryption: {
          ssekms: {
            keyId: 'keyId',
          },
          sses3: sses3,
        },
      },
    },
    exclude: {
      buckets: ['buckets'],
      regions: ['regions'],
    },
    expandedPrefixesDataExport: {
      s3BucketDestination: {
        accountId: 'accountId',
        arn: 'arn',
        format: 'format',
        outputSchemaVersion: 'outputSchemaVersion',

        // the properties below are optional
        encryption: {
          ssekms: {
            keyId: 'keyId',
          },
          sses3: sses3,
        },
        prefix: 'prefix',
      },
      storageLensTableDestination: {
        isEnabled: false,

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

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

Properties ​

storageLensConfigurationIResolvable | CfnStorageLens.StorageLensConfigurationPropertystorage_lens_configurationtyping.Union[IResolvable, StorageLensConfigurationProperty]storageLensConfigurationIResolvableStorageLensConfigurationIResolvableStorageLensConfigurationinterface{}required#
This resource contains the details Amazon S3 Storage Lens configuration.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A set of tags (key–value pairs) to associate with the Storage Lens configuration.