Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Simple Storage Service Resource Types Reference » AWS::S3::Bucket » Amazon S3 Bucket MetricsConfiguration

Amazon S3 Bucket MetricsConfiguration

The MetricsConfiguration property type 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 more information, see PUT Bucket metrics in the Amazon Simple Storage Service (Amazon S3) API Reference.

MetricsConfiguration is a property of the AWS::S3::Bucket resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Id" : String,
  "Prefix" : String,
  "TagFilters" : [ TagFilter, ... ]
}

YAML

Id: String
Prefix: String
TagFilters: 
  - TagFilter

Properties

For more information and valid values, see PUT Bucket metrics in the Amazon Simple Storage Service (Amazon S3) API Reference.

Id

The ID used to identify the metrics configuration.

Required: Yes

Type: String

Update requires: No interruption

Prefix

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

Required: No

Type: String

Update requires: No interruption

TagFilters

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.

Required: No

Type: List of TagFilter

Update requires: No interruption

On this page: