AWS::S3::Bucket MetricsConfiguration - AWS CloudFormation
SyntaxPropertiesSee also

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::S3::Bucket MetricsConfiguration

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.

Syntax

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

JSON

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

YAML

  AccessPointArn: String
  Id: String
  Prefix: String
  TagFilters: 
    - TagFilter

Properties

AccessPointArn

The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria.

Required: No

Type: String

Update requires: No interruption

Id

The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your 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: Array of TagFilter

Update requires: No interruption

See also