View a markdown version of this page

AWS::ObservabilityAdmin::TelemetryRule TelemetryRule - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::ObservabilityAdmin::TelemetryRule TelemetryRule

Defines how telemetry should be configured for specific Amazon resources.

Syntax

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

JSON

{
  "AllowFieldUpdates" : Boolean,
  "AllRegions" : Boolean,
  "DestinationConfiguration" : TelemetryDestinationConfiguration,
  "Regions" : [ String, ... ],
  "ResourceType" : String,
  "SelectionCriteria" : String,
  "TelemetrySourceTypes" : [ String, ... ],
  "TelemetryType" : String
}

Properties

AllowFieldUpdates

If set to true, Amazon CloudWatch Observability Admin detects and remediates configuration drift in telemetry resources that it manages. For example, if a VPC flow log's format, traffic type, or aggregation interval no longer matches the rule's destination configuration, the flow log is replaced with one that matches. Only Observability Admin-managed resources are updated; customer-created resources are never modified. Currently supported for AWS::EC2::VPC resources (VPC flow logs).

Required: No

Type: Boolean

Update requires: No interruption

AllRegions

If set to true, the telemetry rule is replicated to all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. When new regions become available, the rule automatically replicates to them. Mutually exclusive with Regions.

Required: No

Type: Boolean

Update requires: Replacement

DestinationConfiguration

Configuration specifying where and how the telemetry data should be delivered.

Required: No

Type: TelemetryDestinationConfiguration

Update requires: No interruption

Regions

An optional list of Amazon Web Services Regions where this telemetry rule should be replicated. When specified, the rule is created in the home region and automatically replicated to all listed regions. Mutually exclusive with AllRegions.

Required: No

Type: Array of String

Update requires: No interruption

ResourceType

The type of Amazon resource to configure telemetry for (for example, AWS::EC2::VPC, AWS::EKS::Cluster, AWS::ElasticLoadBalancingV2::LoadBalancer, or AWS::Bedrock::KnowledgeBase).

Required: Yes

Type: String

Allowed values: AWS::EC2::VPC | AWS::WAFv2::WebACL | AWS::CloudTrail | AWS::EKS::Cluster | AWS::ElasticLoadBalancingV2::LoadBalancer | AWS::EC2::Instance | AWS::BedrockAgentCore::Runtime | AWS::BedrockAgentCore::Browser | AWS::BedrockAgentCore::CodeInterpreter | AWS::SecurityHub::Hub

Update requires: No interruption

SelectionCriteria

Criteria for selecting which resources the rule applies to, such as resource tags.

Required: No

Type: String

Update requires: No interruption

TelemetrySourceTypes

The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.

Required: No

Type: Array of String

Update requires: No interruption

TelemetryType

The type of telemetry to collect (Logs, Metrics, or Traces).

Required: Yes

Type: String

Allowed values: Logs | Traces | Metrics

Update requires: No interruption