indexing_rules

Creates, updates, deletes, gets or lists an indexing_rules resource.

Overview

Name	indexing_rules
Type	Resource
Id	aws.xray.indexing_rules

Fields

The following fields are returned by SELECT queries:

get_indexing_rules

Name	Datatype	Description
indexing_rules	array	Retrieves all indexing rules.
next_token	string	Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_indexing_rules	select	region		Retrieves all indexing rules. Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.
update_indexing_rule	update	region, Name, Rule		Modifies an indexing rule’s configuration. Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_indexing_rules

Retrieves all indexing rules. Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.

SELECT
indexing_rules,
next_token
FROM aws.xray.indexing_rules
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_indexing_rule

Modifies an indexing rule’s configuration. Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

UPDATE aws.xray.indexing_rules
SET 
Name = '{{ Name }}',
Rule = '{{ Rule }}'
WHERE 
region = '{{ region }}' --required
AND Name = '{{ Name }}' --required
AND Rule = '{{ Rule }}' --required
RETURNING
indexing_rule;