CfnGroupProps

class aws_cdk.aws_xray.CfnGroupProps(*, group_name, filter_expression=None, insights_configuration=None, tags=None)

Bases: object

Properties for defining a CfnGroup.

Parameters:

group_name (str) – The unique case-sensitive name of the group.
filter_expression (Optional[str]) – The filter expression defining the parameters to include traces.
insights_configuration (Union[IResolvable, InsightsConfigurationProperty, Dict[str, Any], None]) – The structure containing configurations related to insights. - 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.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 import aws_xray as xray

cfn_group_props = xray.CfnGroupProps(
    group_name="groupName",

    # the properties below are optional
    filter_expression="filterExpression",
    insights_configuration=xray.CfnGroup.InsightsConfigurationProperty(
        insights_enabled=False,
        notifications_enabled=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

filter_expression

The filter expression defining the parameters to include traces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-filterexpression

group_name

The unique case-sensitive name of the group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-groupname

insights_configuration

The structure containing configurations related to insights.

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-insightsconfiguration

tags

An array of key-value pairs to apply to this resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html#cfn-xray-group-tags