CfnSamplingRuleProps

class aws_cdk.aws_xray.CfnSamplingRuleProps(*, sampling_rule=None, tags=None)

Bases: object

Properties for defining a CfnSamplingRule.

Parameters:
  • sampling_rule (Union[IResolvable, SamplingRuleProperty, Dict[str, Any], None]) – The sampling rule to be created or updated.

  • tags (Optional[Sequence[Any]]) – An array of key-value pairs to apply to this resource.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-xray-samplingrule.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_sampling_rule_props = xray.CfnSamplingRuleProps(
    sampling_rule=xray.CfnSamplingRule.SamplingRuleProperty(
        fixed_rate=123,
        host="host",
        http_method="httpMethod",
        priority=123,
        reservoir_size=123,
        resource_arn="resourceArn",
        service_name="serviceName",
        service_type="serviceType",
        url_path="urlPath",

        # the properties below are optional
        attributes={
            "attributes_key": "attributes"
        },
        rule_arn="ruleArn",
        rule_name="ruleName",
        version=123
    ),
    tags=[tags]
)

Attributes

sampling_rule

The sampling rule to be created or updated.

Link:

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

tags

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

Link:

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