interface CfnGroupProps

Language	Type name
.NET	Amazon.CDK.AWS.XRay.CfnGroupProps
Java	software.amazon.awscdk.services.xray.CfnGroupProps
Python	aws_cdk.aws_xray.CfnGroupProps
TypeScript	@aws-cdk/aws-xray » CfnGroupProps

Properties for defining a CfnGroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as xray from '@aws-cdk/aws-xray';

declare const tags: any;
const cfnGroupProps: xray.CfnGroupProps = {
  groupName: 'groupName',

  // the properties below are optional
  filterExpression: 'filterExpression',
  insightsConfiguration: {
    insightsEnabled: false,
    notificationsEnabled: false,
  },
  tags: [tags],
};

Properties

Name	Type	Description
groupName	string	The unique case-sensitive name of the group.
filterExpression?	string	The filter expression defining the parameters to include traces.
insightsConfiguration?	InsightsConfigurationProperty | IResolvable	The structure containing configurations related to insights.
tags?	any[]	An array of key-value pairs to apply to this resource.

---

groupName

Type: string

The unique case-sensitive name of the group.

---

filterExpression?

Type: string (optional)

The filter expression defining the parameters to include traces.

---

insightsConfiguration?

Type: InsightsConfigurationProperty | IResolvable (optional)

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.

---

tags?

Type: any[] (optional)

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