telemetry_rules

Creates, updates, deletes or gets a telemetry_rule resource or lists telemetry_rules in a region

Overview

Name	telemetry_rules
Type	Resource
Description	The AWS::ObservabilityAdmin::TelemetryRule resource defines a CloudWatch Observability Admin Telemetry Rule.
Id	awscc.observabilityadmin.telemetry_rules

Fields

Name	Datatype	Description
rule_name	string	The name of the telemetry rule
▶rule	object	The AWS::ObservabilityAdmin::TelemetryRule resource defines a CloudWatch Observability Admin Telemetry Rule.
rule_arn	string	The arn of the telemetry rule
▶tags	array	An array of key-value pairs to apply to this resource
region	string	AWS region.

For more information, see AWS::ObservabilityAdmin::TelemetryRule.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	RuleName, Rule, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual telemetry_rule.

SELECT
region,
rule_name,
rule,
rule_arn,
tags
FROM awscc.observabilityadmin.telemetry_rules
WHERE region = 'us-east-1' AND data__Identifier = '<RuleArn>';

INSERT example

Use the following StackQL query and manifest file to create a new telemetry_rule resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.observabilityadmin.telemetry_rules (
 RuleName,
 Rule,
 region
)
SELECT 
'{{ RuleName }}',
 '{{ Rule }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.observabilityadmin.telemetry_rules (
 RuleName,
 Rule,
 Tags,
 region
)
SELECT 
 '{{ RuleName }}',
 '{{ Rule }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: telemetry_rule
    props:
      - name: RuleName
        value: '{{ RuleName }}'
      - name: Rule
        value:
          RuleName: '{{ RuleName }}'
          Rule: null
          Tags:
            - Key: '{{ Key }}'
              Value: '{{ Value }}'
      - name: Tags
        value:
          - null

DELETE example

/*+ delete */
DELETE FROM awscc.observabilityadmin.telemetry_rules
WHERE data__Identifier = '<RuleArn>'
AND region = 'us-east-1';

Permissions

To operate on the telemetry_rules resource, the following permissions are required:

Create

observabilityadmin:CreateTelemetryRule,
observabilityadmin:GetTelemetryRule,
observabilityadmin:TagResource,
observabilityadmin:ListTagsForResource,
observabilityadmin:GetTelemetryEvaluationStatus,
iam:CreateServiceLinkedRole

Read

observabilityadmin:GetTelemetryRule,
observabilityadmin:ListTagsForResource,
observabilityadmin:GetTelemetryEvaluationStatus

Update

observabilityadmin:UpdateTelemetryRule,
observabilityadmin:GetTelemetryRule,
observabilityadmin:TagResource,
observabilityadmin:UntagResource,
observabilityadmin:ListTagsForResource,
observabilityadmin:GetTelemetryEvaluationStatus

Delete

observabilityadmin:DeleteTelemetryRule,
observabilityadmin:GetTelemetryEvaluationStatus

List

observabilityadmin:ListTelemetryRules,
observabilityadmin:GetTelemetryEvaluationStatus