AWS CDK Reference

Appearance

v2.274.0

CfnSamplingRulePropsMixin Mixin ​

Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.

Include a SamplingRule entity to create or update a sampling rule.

SamplingRule.Version can only be set when creating a sampling rule. Updating the version will cause the update to fail.

Services retrieve rules with GetSamplingRules , and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

CloudFormation
AWS::XRay::SamplingRule
Source
Generated code
Type last changed
v2.269.0 · 16 Sep 2026

Initializer ​

ts
new CfnSamplingRulePropsMixin(props: CfnSamplingRuleMixinProps, options?: CfnPropertyMixinOptions)
python
CfnSamplingRulePropsMixin(props: CfnSamplingRuleMixinProps, options: typing.Optional[CfnPropertyMixinOptions] = None)
java
new CfnSamplingRulePropsMixin(CfnSamplingRuleMixinProps props, CfnPropertyMixinOptions options)
csharp
new CfnSamplingRulePropsMixin(CfnSamplingRuleMixinProps props, CfnPropertyMixinOptions? options = null)
go
NewCfnSamplingRulePropsMixin(Props CfnSamplingRuleMixinProps, Options CfnPropertyMixinOptions)

Methods ​

applyTo(construct: IConstruct): voiddef apply_to(self, construct: IConstruct) -> Nonepublic void applyTo(IConstruct construct)public void ApplyTo(IConstruct construct)func ApplyTo(Construct IConstruct)#
Apply the mixin properties to the construct.
isMixin(x: any): boolean@staticmethod def is_mixin(x: Any) -> boolpublic static Boolean isMixin(Object x)public static bool IsMixin(object x)func IsMixin(X interface{}) *boolstatic#
Checks if `x` is a Mixin.
1 parameter · returns

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Mixin.

supports(construct: IConstruct): booleandef supports(self, construct: IConstruct) -> boolpublic Boolean supports(IConstruct construct)public bool Supports(IConstruct construct)func Supports(Construct IConstruct) *bool#
Check if this mixin supports the given construct.