CfnGroupProps

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

Bases: object

Properties for defining a CfnGroup.

Parameters
  • filter_expression (Optional[str]) – The filter expression defining the parameters to include traces.

  • group_name (Optional[str]) – The unique case-sensitive name of the group.

  • insights_configuration (Union[InsightsConfigurationProperty, Dict[str, Any], IResolvable, 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[Any]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

Link

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.
import aws_cdk.aws_xray as xray

# tags: Any

cfn_group_props = xray.CfnGroupProps(
    filter_expression="filterExpression",
    group_name="groupName",
    insights_configuration=xray.CfnGroup.InsightsConfigurationProperty(
        insights_enabled=False,
        notifications_enabled=False
    ),
    tags=[tags]
)

Attributes

filter_expression

The filter expression defining the parameters to include traces.

Link

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

Return type

Optional[str]

group_name

The unique case-sensitive name of the group.

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Union[InsightsConfigurationProperty, IResolvable, None]

tags

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

For more information, see Tag .

Link

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

Return type

Optional[List[Any]]