Package software.amazon.awscdk.services.applicationsignals

Interface CfnGroupingConfiguration.GroupingAttributeDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGroupingConfiguration.GroupingAttributeDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnGroupingConfiguration

@Stability(Stable)
public static interface CfnGroupingConfiguration.GroupingAttributeDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.applicationsignals.*;
 GroupingAttributeDefinitionProperty groupingAttributeDefinitionProperty = GroupingAttributeDefinitionProperty.builder()
         .groupingName("groupingName")
         .groupingSourceKeys(List.of("groupingSourceKeys"))
         // the properties below are optional
         .defaultGroupingValue("defaultGroupingValue")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGroupingConfiguration.GroupingAttributeDefinitionProperty.Builder	A builder for CfnGroupingConfiguration.GroupingAttributeDefinitionProperty
static final class	CfnGroupingConfiguration.GroupingAttributeDefinitionProperty.Jsii$Proxy	An implementation for CfnGroupingConfiguration.GroupingAttributeDefinitionProperty

Method Summary

Modifier and Type	Method	Description
static CfnGroupingConfiguration.GroupingAttributeDefinitionProperty.Builder	builder()
default String	getDefaultGroupingValue()	The default value to use for this grouping attribute when no value can be derived from the source keys.
String	getGroupingName()	The friendly name for this grouping attribute, such as BusinessUnit or Environment .
List<String>	getGroupingSourceKeys()	An array of source keys used to derive the grouping attribute value from telemetry data, AWS tags, or other sources.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGroupingName

@Stability(Stable)
@NotNull
String getGroupingName()

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

getGroupingSourceKeys

@Stability(Stable)
@NotNull
List<String> getGroupingSourceKeys()

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

getDefaultGroupingValue

@Stability(Stable)
@Nullable
default String getDefaultGroupingValue()

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

builder

@Stability(Stable)
static CfnGroupingConfiguration.GroupingAttributeDefinitionProperty.Builder builder()

Returns:

a CfnGroupingConfiguration.GroupingAttributeDefinitionProperty.Builder of CfnGroupingConfiguration.GroupingAttributeDefinitionProperty