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

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
▶rule	object	The AWS::ObservabilityAdmin::TelemetryRule resource defines a CloudWatch Observability Admin Telemetry Rule.
rule_arn	string	The arn of the telemetry rule
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	telemetry_rules	INSERT	RuleName, Rule, region
delete_resource	telemetry_rules	DELETE	Identifier, region
update_resource	telemetry_rules	UPDATE	Identifier, PatchDocument, region
list_resources	telemetry_rules_list_only	SELECT	region
get_resource	telemetry_rules	SELECT	Identifier, region

SELECT examples

get (all properties)

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
  Identifier = '{{ rule_arn }}';

list (identifiers only)

Lists all telemetry_rules in a region.

SELECT
  region,
  rule_arn
FROM awscc.observabilityadmin.telemetry_rules_list_only
WHERE
  region = 'us-east-1';

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
  '{{ rule_name }}',
  '{{ rule }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.observabilityadmin.telemetry_rules (
  RuleName,
  Rule,
  Tags,
  region
)
SELECT
  '{{ rule_name }}',
  '{{ 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: rule_name
        value: '{{ rule_name }}'
      - name: rule
        value:
          rule_name: '{{ rule_name }}'
          rule: null
          tags:
            - key: '{{ key }}'
              value: '{{ value }}'
      - name: tags
        value:
          - null

UPDATE example

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

/*+ update */
UPDATE awscc.observabilityadmin.telemetry_rules
SET PatchDocument = string('{{ {
    "Rule": rule,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ rule_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.observabilityadmin.telemetry_rules
WHERE
  Identifier = '{{ rule_arn }}' 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