CfnSamplingRuleProps

class aws_cdk.aws_xray.CfnSamplingRuleProps(*, rule_name=None, sampling_rule=None, sampling_rule_record=None, sampling_rule_update=None, tags=None)

Bases: object

Properties for defining a CfnSamplingRule.

Parameters:

rule_name (Optional[str]) – (deprecated) The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
sampling_rule (Union[IResolvable, SamplingRuleProperty, Dict[str, Any], None]) – The sampling rule to be created or updated.
sampling_rule_record (Union[IResolvable, SamplingRuleRecordProperty, Dict[str, Any], None]) –
sampling_rule_update (Union[IResolvable, SamplingRuleUpdateProperty, Dict[str, Any], None]) –
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-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.
from aws_cdk import aws_xray as xray

cfn_sampling_rule_props = xray.CfnSamplingRuleProps(
    rule_name="ruleName",
    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
    ),
    sampling_rule_record=xray.CfnSamplingRule.SamplingRuleRecordProperty(
        created_at="createdAt",
        modified_at="modifiedAt",
        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
        )
    ),
    sampling_rule_update=xray.CfnSamplingRule.SamplingRuleUpdateProperty(
        attributes={
            "attributes_key": "attributes"
        },
        fixed_rate=123,
        host="host",
        http_method="httpMethod",
        priority=123,
        reservoir_size=123,
        resource_arn="resourceArn",
        rule_arn="ruleArn",
        rule_name="ruleName",
        service_name="serviceName",
        service_type="serviceType",
        url_path="urlPath"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)