groups

Creates, updates, deletes or gets a group resource or lists groups in a region

Overview

Name	groups
Type	Resource
Description	This schema provides construct and validation rules for AWS-XRay Group resource parameters.
Id	aws.xray.groups

Fields

Name	Datatype	Description
filter_expression	string	The filter expression defining criteria by which to group traces.
group_name	string	The case-sensitive name of the new group. Names must be unique.
group_arn	string	The ARN of the group that was generated on creation.
insights_configuration	object
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	GroupName, 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 groups in a region.

SELECT
region,
filter_expression,
group_name,
group_arn,
insights_configuration,
tags
FROM aws.xray.groups
WHERE region = 'us-east-1';

Gets all properties from an individual group.

SELECT
region,
filter_expression,
group_name,
group_arn,
insights_configuration,
tags
FROM aws.xray.groups
WHERE region = 'us-east-1' AND data__Identifier = '<GroupARN>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.xray.groups (
 GroupName,
 region
)
SELECT 
'{{ GroupName }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: group
    props:
      - name: FilterExpression
        value: '{{ FilterExpression }}'
      - name: GroupName
        value: '{{ GroupName }}'
      - name: InsightsConfiguration
        value:
          InsightsEnabled: '{{ InsightsEnabled }}'
          NotificationsEnabled: '{{ NotificationsEnabled }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.xray.groups
WHERE data__Identifier = '<GroupARN>'
AND region = 'us-east-1';

Permissions

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

Create

xray:CreateGroup,
xray:TagResource

Read

xray:GetGroup,
xray:ListTagsForResource

Update

xray:UpdateGroup,
xray:TagResource,
xray:UntagResource,
xray:ListTagsForResource

Delete

xray:DeleteGroup

List

xray:GetGroups,
xray:ListTagsForResource