AWS::XRay::Group - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::XRay::Group

Use the AWS::XRay::Group resource to specify a group with a name and a filter expression.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::XRay::Group",
  "Properties" : {
      "FilterExpression" : String,
      "GroupName" : String,
      "InsightsConfiguration" : InsightsConfiguration,
      "Tags" : [ Json, ... ]
    }
}

YAML

Type: AWS::XRay::Group
Properties: 
  FilterExpression: String
  GroupName: String
  InsightsConfiguration: 
    InsightsConfiguration
  Tags: 
    - Json

Properties

FilterExpression

The filter expression defining the parameters to include traces.

Required: No

Type: String

Update requires: No interruption

GroupName

The unique case-sensitive name of the group.

Required: No

Type: String

Update requires: No interruption

InsightsConfiguration

The structure containing configurations related to insights.

  • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.

  • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.

Required: No

Type: InsightsConfiguration

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: List of Json

Update requires: No interruption

Return values

Fn::GetAtt

GroupARN

The group ARN that was created or updated.

Examples

Create group

This example creates a new group called MyGroup

JSON


{
   "AWSTemplateFormatVersion": "2010-09-09",
   "Description": "XRay stack",
   "Resources": {
      "TestGrpResource": {
         "Type": "AWS::XRay::Group",
         "Properties": {
            "GroupName": "MyGroup",
            "FilterExpression": "duration > 10",
            "InsightsConfiguration": {
               "InsightsEnabled": "false",
               "NotificationsEnabled": "false"
            }
         }
      }
   }
}

YAML


AWSTemplateFormatVersion: 2010-09-09
Resources:
   Group:
      Type: AWS::XRay::Group
      Properties:
         GroupName: MyGroup
         FilterExpression: duration > 10
         InsightsConfiguration:
            InsightsEnabled: false
            NotificationsEnabled: false

See also