AWS::ObservabilityAdmin::TelemetryRule - AWS CloudFormation
SyntaxPropertiesReturn values

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::ObservabilityAdmin::TelemetryRule

Creates a telemetry rule that defines how telemetry should be configured for AWS resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

Syntax

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

JSON

{
  "Type" : "AWS::ObservabilityAdmin::TelemetryRule",
  "Properties" : {
      "Rule" : TelemetryRule,
      "RuleName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::ObservabilityAdmin::TelemetryRule
Properties:
  Rule: 
    TelemetryRule
  RuleName: String
  Tags: 
    - Tag

Properties

Rule

Retrieves the details of a specific telemetry rule in your account.

Required: Yes

Type: TelemetryRule

Update requires: No interruption

RuleName

The name of the telemetry rule.

Required: Yes

Type: String

Pattern: ^[0-9A-Za-z-]+$

Minimum: 1

Maximum: 100

Update requires: Replacement

Tags

Lists all tags attached to the specified telemetry rule resource.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

Fn::GetAtt

RuleArn

The Amazon Resource Name (ARN) of the telemetry rule.