transaction_search_configs

Creates, updates, deletes or gets a transaction_search_config resource or lists transaction_search_configs in a region

Overview

Name	transaction_search_configs
Type	Resource
Description	This schema provides construct and validation rules for AWS-XRay TransactionSearchConfig resource parameters.
Id	awscc.xray.transaction_search_configs

Fields

get (all properties)

Name	Datatype	Description
account_id	string	User account id, used as the primary identifier for the resource
indexing_percentage	number	Determines the percentage of traces indexed from CloudWatch Logs to X-Ray
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
account_id	string	User account id, used as the primary identifier for the resource
region	string	AWS region.

For more information, see AWS::XRay::TransactionSearchConfig.

Methods

Name	Resource	Accessible by	Required Params
create_resource	transaction_search_configs	INSERT	region
delete_resource	transaction_search_configs	DELETE	Identifier, region
update_resource	transaction_search_configs	UPDATE	Identifier, PatchDocument, region
list_resources	transaction_search_configs_list_only	SELECT	region
get_resource	transaction_search_configs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual transaction_search_config.

SELECT
  region,
  account_id,
  indexing_percentage
FROM awscc.xray.transaction_search_configs
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ account_id }}';

list (identifiers only)

Lists all transaction_search_configs in a region.

SELECT
  region,
  account_id
FROM awscc.xray.transaction_search_configs_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.xray.transaction_search_configs (
  IndexingPercentage,
  region
)
SELECT
  '{{ indexing_percentage }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.xray.transaction_search_configs (
  IndexingPercentage,
  region
)
SELECT
  '{{ indexing_percentage }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: transaction_search_config
    props:
      - name: indexing_percentage
        value: null

UPDATE example

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

/*+ update */
UPDATE awscc.xray.transaction_search_configs
SET PatchDocument = string('{{ {
    "IndexingPercentage": indexing_percentage
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ account_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.xray.transaction_search_configs
WHERE
  Identifier = '{{ account_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

application-signals:StartDiscovery,
iam:CreateServiceLinkedRole,
logs:CreateLogGroup,
logs:CreateLogStream,
logs:PutRetentionPolicy,
xray:GetIndexingRules,
xray:GetTraceSegmentDestination,
xray:UpdateIndexingRule,
xray:UpdateTraceSegmentDestination

Read

xray:GetTraceSegmentDestination,
xray:GetIndexingRules

List

xray:GetTraceSegmentDestination,
xray:GetIndexingRules

Update

xray:GetIndexingRules,
xray:GetTraceSegmentDestination,
xray:UpdateIndexingRule

Delete

xray:GetTraceSegmentDestination,
xray:UpdateTraceSegmentDestination,
xray:UpdateIndexingRule