TelemetryRule
Defines how telemetry should be configured for specific AWS resources.
Contents
- TelemetryType
-
The type of telemetry to collect (Logs, Metrics, or Traces).
Type: String
Valid Values:
Logs | Metrics | TracesRequired: Yes
- 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 forAWS::EC2::VPCresources (VPC flow logs).Type: Boolean
Required: No
- AllRegions
-
If set to
true, the telemetry rule is replicated to all AWS 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 withRegions.Type: Boolean
Required: No
- DestinationConfiguration
-
Configuration specifying where and how the telemetry data should be delivered.
Type: TelemetryDestinationConfiguration object
Required: No
- Regions
-
An optional list of AWS 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.Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Minimum length of 1.
Required: No
- ResourceType
-
The type of AWS resource to configure telemetry for (for example,
AWS::EC2::VPC,AWS::EKS::Cluster,AWS::ElasticLoadBalancingV2::LoadBalancer, orAWS::Bedrock::KnowledgeBase).Type: String
Valid Values:
AWS::EC2::Instance | AWS::EC2::VPC | AWS::Lambda::Function | AWS::CloudTrail | AWS::EKS::Cluster | AWS::WAFv2::WebACL | AWS::ElasticLoadBalancingV2::LoadBalancer | AWS::Route53Resolver::ResolverEndpoint | AWS::BedrockAgentCore::Runtime | AWS::BedrockAgentCore::Browser | AWS::BedrockAgentCore::CodeInterpreter | AWS::BedrockAgentCore::Gateway | AWS::BedrockAgentCore::Memory | AWS::BedrockAgentCore::WorkloadIdentity | AWS::SecurityHub::Hub | AWS::CloudFront::Distribution | AWS::SecurityHub::HubV2 | AWS::CloudWatch::OTelEnrichment | AWS::MSK::Cluster | AWS::S3::Bucket | AWS::Bedrock::KnowledgeBaseRequired: No
- Scope
-
The organizational scope to which the rule applies, specified using accounts or organizational units.
Type: String
Required: No
- SelectionCriteria
-
Criteria for selecting which resources the rule applies to, such as resource tags.
Type: String
Required: No
- 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.
Type: Array of strings
Valid Values:
VPC_FLOW_LOGS | ROUTE53_RESOLVER_QUERY_LOGS | EKS_AUDIT_LOGS | EKS_AUTHENTICATOR_LOGS | EKS_CONTROLLER_MANAGER_LOGS | EKS_SCHEDULER_LOGS | EKS_API_LOGSRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: