Interface CfnGroupingConfiguration.IGroupingAttributeDefinitionProperty

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

Namespace: Amazon.CDK.AWS.ApplicationSignals

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnGroupingConfiguration.IGroupingAttributeDefinitionProperty

Syntax (vb)

Public Interface CfnGroupingConfiguration.IGroupingAttributeDefinitionProperty

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ApplicationSignals;

             var groupingAttributeDefinitionProperty = new GroupingAttributeDefinitionProperty {
                 GroupingName = "groupingName",
                 GroupingSourceKeys = new [] { "groupingSourceKeys" },

                 // the properties below are optional
                 DefaultGroupingValue = "defaultGroupingValue"
             };

Synopsis

Properties

DefaultGroupingValue	The default value to use for this grouping attribute when no value can be derived from the source keys.
GroupingName	The friendly name for this grouping attribute, such as `BusinessUnit` or `Environment` .
GroupingSourceKeys	An array of source keys used to derive the grouping attribute value from telemetry data, AWS tags, or other sources.

Properties

DefaultGroupingValue

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

string? DefaultGroupingValue { get; }

Property Value

string

Remarks

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

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

GroupingName

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

string GroupingName { get; }

Property Value

string

Remarks

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

GroupingSourceKeys

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

string[] GroupingSourceKeys { get; }

Property Value

string[]

Remarks

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