View a markdown version of this page

AWS::CloudWatch::OTelEnrichment - AWS CloudFormation
SyntaxPropertiesReturn values

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

AWS::CloudWatch::OTelEnrichment

Enables OpenTelemetry (OTel) metric enrichment in Amazon CloudWatch, allowing CloudWatch vended metrics to be available for PromQL querying enriched with AWS resource tags and metadata.

This is a singleton resource — only one OTelEnrichment resource can exist per AWS account. Creating the resource starts enrichment, and deleting it stops enrichment.

By default, enrichment applies to every namespace that CloudWatch supports. To limit enrichment to a subset of metrics, specify IncludeFilters, ExcludeFilters, or both. You can change the filters without interrupting enrichment. CloudFormation applies the change by calling UpdateOTelEnrichment.

Before creating this resource, you must enable resource tags on telemetry for your account. For more information, see Supported AWS infrastructure metrics in the Amazon CloudWatch User Guide.

Syntax

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

JSON

{
  "Type" : "AWS::CloudWatch::OTelEnrichment",
  "Properties" : {
      "ExcludeFilters" : [ OTelEnrichmentMetricSelector, ... ],
      "IncludeFilters" : [ OTelEnrichmentMetricSelector, ... ]
    }
}

YAML

Type: AWS::CloudWatch::OTelEnrichment
Properties:
  ExcludeFilters: 
    - OTelEnrichmentMetricSelector
  IncludeFilters: 
    - OTelEnrichmentMetricSelector

Properties

ExcludeFilters

The metric namespaces, and the metric names, to leave unenriched. If this parameter is omitted, nothing is excluded.

Amazon CloudWatch applies ExcludeFilters after IncludeFilters, so a metric that both parameters match is not enriched.

A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.

Required: No

Type: Array of OTelEnrichmentMetricSelector

Maximum: 100

Update requires: No interruption

IncludeFilters

The metric namespaces, and the metric names, to enrich. If this parameter is omitted, every namespace that Amazon CloudWatch supports for enrichment is in scope.

A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.

Required: No

Type: Array of OTelEnrichmentMetricSelector

Maximum: 100

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns AWS account ID.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AccountId

The AWS account ID. This is the primary identifier for this singleton resource.

Status

The current status of OTel enrichment for the account. Valid values are RUNNING (enrichment is enabled) and STOPPED (enrichment is disabled).