interface StorageLensConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.S3.CfnStorageLens.StorageLensConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnStorageLens_StorageLensConfigurationProperty`
Java	`software.amazon.awscdk.services.s3.CfnStorageLens.StorageLensConfigurationProperty`
Python	`aws_cdk.aws_s3.CfnStorageLens.StorageLensConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_s3` » `CfnStorageLens` » `StorageLensConfigurationProperty`

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

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 storageLensConfigurationProperty: s3.CfnStorageLens.StorageLensConfigurationProperty = {
  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,
    },
    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',
    },
  },
  exclude: {
    buckets: ['buckets'],
    regions: ['regions'],
  },
  include: {
    buckets: ['buckets'],
    regions: ['regions'],
  },
  storageLensArn: 'storageLensArn',
};

Properties

Name	Type	Description
accountLevel	`IResolvable` `\|` `AccountLevelProperty`	This property contains the details of the account-level metrics for Amazon S3 Storage Lens configuration.
id	`string`	This property contains the details of the ID of the S3 Storage Lens configuration.
isEnabled	`boolean \|` `IResolvable`	This property contains the details of whether the Amazon S3 Storage Lens configuration is enabled.
awsOrg?	`IResolvable` `\|` `AwsOrgProperty`	This property contains the details of the AWS Organization for the S3 Storage Lens configuration.
dataExport?	`IResolvable` `\|` `DataExportProperty`	This property contains the details of this S3 Storage Lens configuration's metrics export.
exclude?	`IResolvable` `\|` `BucketsAndRegionsProperty`	This property contains the details of the bucket and or Regions excluded for Amazon S3 Storage Lens configuration.
include?	`IResolvable` `\|` `BucketsAndRegionsProperty`	This property contains the details of the bucket and or Regions included for Amazon S3 Storage Lens configuration.
storageLensArn?	`string`	This property contains the details of the ARN of the S3 Storage Lens configuration.

accountLevel

Type: IResolvable | AccountLevelProperty

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

id

Type: string

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

isEnabled

Type: boolean | IResolvable

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

awsOrg?

Type: IResolvable | AwsOrgProperty (optional)

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

dataExport?

Type: IResolvable | DataExportProperty (optional)

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

exclude?

Type: IResolvable | BucketsAndRegionsProperty (optional)

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

include?

Type: IResolvable | BucketsAndRegionsProperty (optional)

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

storageLensArn?

Type: string (optional)

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

This property is read-only.