aws-cdk-lib.aws_xray.CfnGroupProps

interface CfnGroupProps

LanguageType name
.NETAmazon.CDK.AWS.XRay.CfnGroupProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsxray#CfnGroupProps
Javasoftware.amazon.awscdk.services.xray.CfnGroupProps
Pythonaws_cdk.aws_xray.CfnGroupProps
TypeScript aws-cdk-lib » 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 { aws_xray as xray } from 'aws-cdk-lib';

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

NameTypeDescription
groupNamestringThe unique case-sensitive name of the group.
filterExpression?stringThe filter expression defining the parameters to include traces.
insightsConfiguration?IResolvable | InsightsConfigurationPropertyThe 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: IResolvable | InsightsConfigurationProperty (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.