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 AWS::XRay::SamplingRule.

Parameters
Link

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

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 is of type object

cfn_sampling_rule_props = xray.CfnSamplingRuleProps(
    rule_name="ruleName",
    sampling_rule=xray.CfnSamplingRule.SamplingRuleProperty(
        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",
        version=123
    ),
    sampling_rule_record=xray.CfnSamplingRule.SamplingRuleRecordProperty(
        created_at="createdAt",
        modified_at="modifiedAt",
        sampling_rule=xray.CfnSamplingRule.SamplingRuleProperty(
            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",
            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=[tags]
)

Attributes

rule_name

AWS::XRay::SamplingRule.RuleName.

Link

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

Return type

Optional[str]

sampling_rule

AWS::XRay::SamplingRule.SamplingRule.

Link

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

Return type

Union[SamplingRuleProperty, IResolvable, None]

sampling_rule_record

AWS::XRay::SamplingRule.SamplingRuleRecord.

Link

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

Return type

Union[IResolvable, SamplingRuleRecordProperty, None]

sampling_rule_update

AWS::XRay::SamplingRule.SamplingRuleUpdate.

Link

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

Return type

Union[IResolvable, SamplingRuleUpdateProperty, None]

tags

AWS::XRay::SamplingRule.Tags.

Link

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

Return type

Optional[List[Any]]