interface GroupingAttributeDefinitionProperty

Language	Type name
.NET	Amazon.CDK.aws_applicationsignals.CfnGroupingConfiguration.GroupingAttributeDefinitionProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsapplicationsignals#CfnGroupingConfiguration_GroupingAttributeDefinitionProperty
Java	software.amazon.awscdk.services.applicationsignals.CfnGroupingConfiguration.GroupingAttributeDefinitionProperty
Python	aws_cdk.aws_applicationsignals.CfnGroupingConfiguration.GroupingAttributeDefinitionProperty
TypeScript	aws-cdk-lib » aws_applicationsignals » CfnGroupingConfiguration » GroupingAttributeDefinitionProperty

A structure that defines how services should be grouped based on specific attributes.

This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_applicationsignals as applicationsignals } from 'aws-cdk-lib';
const groupingAttributeDefinitionProperty: applicationsignals.CfnGroupingConfiguration.GroupingAttributeDefinitionProperty = {
  groupingName: 'groupingName',
  groupingSourceKeys: ['groupingSourceKeys'],

  // the properties below are optional
  defaultGroupingValue: 'defaultGroupingValue',
};

Properties

Name	Type	Description
groupingName	string	The friendly name for this grouping attribute, such as BusinessUnit or Environment .
groupingSourceKeys	string[]	An array of source keys used to derive the grouping attribute value from telemetry data, AWS tags, or other sources.
defaultGroupingValue?	string	The default value to use for this grouping attribute when no value can be derived from the source keys.

---

groupingName

Type: string

The friendly name for this grouping attribute, such as BusinessUnit or Environment .

This name is used to identify the grouping in the console and APIs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-groupingname

---

groupingSourceKeys

Type: string[]

An array of source keys used to derive the grouping attribute value from telemetry data, AWS tags, or other sources.

For example, ["business_unit", "team"] would look for values in those fields.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-groupingsourcekeys

---

defaultGroupingValue?

Type: string (optional)

The default value to use for this grouping attribute when no value can be derived from the source keys.

This ensures all services have a grouping value even if the source data is missing.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-defaultgroupingvalue