interface MetricsConfigurationProperty

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

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket.

If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For examples, see AWS::S3::Bucket . For more information, see PUT Bucket metrics in the Amazon S3 API Reference .

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';
const metricsConfigurationProperty: s3.CfnBucket.MetricsConfigurationProperty = {
  id: 'id',

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

Properties

Name	Type	Description
id	`string`	The ID used to identify the metrics configuration.
accessPointArn?	`string`	The access point that was used while performing operations on the object.
prefix?	`string`	The prefix that an object must have to be included in the metrics results.
tagFilters?	`IResolvable` `\| (IResolvable` `\|` `TagFilterProperty)[]`	Specifies a list of tag filters to use as a metrics configuration filter.

id

Type: string

The ID used to identify the metrics configuration.

This can be any value you choose that helps you identify your metrics configuration.

accessPointArn?

Type: string (optional)

The access point that was used while performing operations on the object.

The metrics configuration only includes objects that meet the filter's criteria.

prefix?

Type: string (optional)

The prefix that an object must have to be included in the metrics results.

tagFilters?

Type: IResolvable | (IResolvable | TagFilterProperty)[] (optional)

Specifies a list of tag filters to use as a metrics configuration filter.

The metrics configuration includes only objects that meet the filter's criteria.