groups

Creates, updates, deletes, gets or lists a groups resource.

Overview

Name	groups
Type	Resource
Id	aws.xray.groups

Fields

The following fields are returned by SELECT queries:

get_group

Name	Datatype	Description
filter_expression	string	The filter expression defining the parameters to include traces.
group_arn	string	The Amazon Resource Name (ARN) of the group generated based on the GroupName.
group_name	string	The unique case-sensitive name of the group.
insights_configuration	object	The structure containing configurations related to insights.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_group	select	region		Retrieves group resource details.
create_group	insert	region, GroupName		Creates a group resource with a name and a filter expression.
update_group	update	region		Updates a group resource.
delete_group	delete	region		Deletes a group resource.
get_groups	exec	region		Retrieves all active group details.

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_group

Retrieves group resource details.

SELECT
filter_expression,
group_arn,
group_name,
insights_configuration
FROM aws.xray.groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_group

Creates a group resource with a name and a filter expression.

INSERT INTO aws.xray.groups (
GroupName,
FilterExpression,
InsightsConfiguration,
Tags,
region
)
SELECT 
'{{ GroupName }}' /* required */,
'{{ FilterExpression }}',
'{{ InsightsConfiguration }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
group
;

Manifest

# Description fields are for documentation purposes
- name: groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the groups resource.
  - name: GroupName
    value: "{{ GroupName }}"
  - name: FilterExpression
    value: "{{ FilterExpression }}"
  - name: InsightsConfiguration
    description: |
      The structure containing configurations related to insights.
    value:
      InsightsEnabled: {{ InsightsEnabled }}
      NotificationsEnabled: {{ NotificationsEnabled }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_group

Updates a group resource.

UPDATE aws.xray.groups
SET 
GroupName = '{{ GroupName }}',
GroupARN = '{{ GroupARN }}',
FilterExpression = '{{ FilterExpression }}',
InsightsConfiguration = '{{ InsightsConfiguration }}'
WHERE 
region = '{{ region }}' --required
RETURNING
group;

DELETE examples

delete_group

Deletes a group resource.

DELETE FROM aws.xray.groups
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

get_groups

Retrieves all active group details.

EXEC aws.xray.groups.get_groups 
@region='{{ region }}' --required 
@@json=
'{
"NextToken": "{{ NextToken }}"
}'
;