CfnGroupingConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_applicationsignals.mixins.CfnGroupingConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

A structure that contains the complete grouping configuration for an account, including all defined grouping attributes and metadata about when it was last updated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-applicationsignals-groupingconfiguration.html
CloudformationResource:: AWS::ApplicationSignals::GroupingConfiguration
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

cfn_grouping_configuration_props_mixin = applicationsignals_mixins.CfnGroupingConfigurationPropsMixin(applicationsignals_mixins.CfnGroupingConfigurationMixinProps(
    grouping_attribute_definitions=[applicationsignals_mixins.CfnGroupingConfigurationPropsMixin.GroupingAttributeDefinitionProperty(
        default_grouping_value="defaultGroupingValue",
        grouping_name="groupingName",
        grouping_source_keys=["groupingSourceKeys"]
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ApplicationSignals::GroupingConfiguration.

Parameters:

props (Union[CfnGroupingConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['groupingAttributeDefinitions']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

GroupingAttributeDefinitionProperty

class CfnGroupingConfigurationPropsMixin.GroupingAttributeDefinitionProperty(*, default_grouping_value=None, grouping_name=None, grouping_source_keys=None)

Bases: object

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.

Parameters:

default_grouping_value (Optional[str]) – 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.
grouping_name (Optional[str]) – 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.
grouping_source_keys (Optional[Sequence[str]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_applicationsignals import mixins as applicationsignals_mixins

grouping_attribute_definition_property = applicationsignals_mixins.CfnGroupingConfigurationPropsMixin.GroupingAttributeDefinitionProperty(
    default_grouping_value="defaultGroupingValue",
    grouping_name="groupingName",
    grouping_source_keys=["groupingSourceKeys"]
)

Attributes

default_grouping_value

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-defaultgroupingvalue

grouping_name

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-groupingname

grouping_source_keys

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-applicationsignals-groupingconfiguration-groupingattributedefinition.html#cfn-applicationsignals-groupingconfiguration-groupingattributedefinition-groupingsourcekeys