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	awscc.xray.groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
group_arn	string	The ARN of the group that was generated on creation.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	groups	INSERT	GroupName, region
delete_resource	groups	DELETE	Identifier, region
update_resource	groups	UPDATE	Identifier, PatchDocument, region
list_resources	groups_list_only	SELECT	region
get_resource	groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual group.

SELECT
  region,
  filter_expression,
  group_name,
  group_arn,
  insights_configuration,
  tags
FROM awscc.xray.groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ group_arn }}';

list (identifiers only)

Lists all groups in a region.

SELECT
  region,
  group_arn
FROM awscc.xray.groups_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.xray.groups (
  GroupName,
  region
)
SELECT
  '{{ group_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.xray.groups (
  FilterExpression,
  GroupName,
  InsightsConfiguration,
  Tags,
  region
)
SELECT
  '{{ filter_expression }}',
  '{{ group_name }}',
  '{{ insights_configuration }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: group
  props:
    - name: filter_expression
      value: '{{ filter_expression }}'
    - name: group_name
      value: '{{ group_name }}'
    - name: insights_configuration
      value:
        insights_enabled: '{{ insights_enabled }}'
        notifications_enabled: '{{ notifications_enabled }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.xray.groups
SET PatchDocument = string('{{ {
    "FilterExpression": filter_expression,
    "GroupName": group_name,
    "InsightsConfiguration": insights_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ group_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.xray.groups
WHERE
  Identifier = '{{ group_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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