CfnGroupPropsMixin

class aws_cdk.mixins_preview.aws_xray.mixins.CfnGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

Use the AWS::XRay::Group resource to specify a group with a name and a filter expression.

Groups enable the collection of traces that match the filter expression, can be used to filter service graphs and traces, and to supply Amazon CloudWatch metrics.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-group.html
CloudformationResource:: AWS::XRay::Group
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_xray import mixins as xray_mixins

cfn_group_props_mixin = xray_mixins.CfnGroupPropsMixin(xray_mixins.CfnGroupMixinProps(
    filter_expression="filterExpression",
    group_name="groupName",
    insights_configuration=xray_mixins.CfnGroupPropsMixin.InsightsConfigurationProperty(
        insights_enabled=False,
        notifications_enabled=False
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::XRay::Group.

Parameters:

props (Union[CfnGroupMixinProps, 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 = ['filterExpression', 'groupName', 'insightsConfiguration', 'tags']

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

InsightsConfigurationProperty

class CfnGroupPropsMixin.InsightsConfigurationProperty(*, insights_enabled=None, notifications_enabled=None)

Bases: object

The structure containing configurations related to insights.

Parameters:

insights_enabled (Union[bool, IResolvable, None]) – Set the InsightsEnabled value to true to enable insights or false to disable insights.
notifications_enabled (Union[bool, IResolvable, None]) – Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-group-insightsconfiguration.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_xray import mixins as xray_mixins

insights_configuration_property = xray_mixins.CfnGroupPropsMixin.InsightsConfigurationProperty(
    insights_enabled=False,
    notifications_enabled=False
)

Attributes

insights_enabled

Set the InsightsEnabled value to true to enable insights or false to disable insights.

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

notifications_enabled

Set the NotificationsEnabled value to true to enable insights notifications.

Notifications can only be enabled on a group with InsightsEnabled set to true.

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