Skip to content
v2.275.0

CfnGroupProps Struct ​

Properties for defining a CfnGroup.

Example ​

ts
// 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';
const cfnGroupProps: xray.CfnGroupProps = {
  groupName: 'groupName',

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

Properties ​

filterExpressionoptionalstringfilter_expressionoptionalstrfilterExpressionoptionalStringFilterExpressionoptionalstringFilterExpressionoptional*string#
The filter expression defining the parameters to include traces.
groupNamestringgroup_namestrgroupNameStringGroupNamestringGroupName*stringrequired#
The unique case-sensitive name of the group.
insightsConfigurationoptionalIResolvable | CfnGroup.InsightsConfigurationPropertyinsights_configurationoptionaltyping.Union[IResolvable, InsightsConfigurationProperty]insightsConfigurationoptionalIResolvableInsightsConfigurationoptionalIResolvableInsightsConfigurationoptionalinterface{}#
The structure containing configurations related to insights.
notes
  • 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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.