Package software.amazon.awscdk.cfnpropertymixins.services.xray

Interface CfnSamplingRuleMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSamplingRuleMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:06.390Z")
@Stability(Stable)
public interface CfnSamplingRuleMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnSamplingRulePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.xray.*;
 CfnSamplingRuleMixinProps cfnSamplingRuleMixinProps = CfnSamplingRuleMixinProps.builder()
         .ruleName("ruleName")
         .samplingRule(SamplingRuleProperty.builder()
                 .attributes(Map.of(
                         "attributesKey", "attributes"))
                 .fixedRate(123)
                 .host("host")
                 .httpMethod("httpMethod")
                 .priority(123)
                 .reservoirSize(123)
                 .resourceArn("resourceArn")
                 .ruleArn("ruleArn")
                 .ruleName("ruleName")
                 .serviceName("serviceName")
                 .serviceType("serviceType")
                 .urlPath("urlPath")
                 .version(123)
                 .build())
         .samplingRuleRecord(SamplingRuleRecordProperty.builder()
                 .createdAt("createdAt")
                 .modifiedAt("modifiedAt")
                 .samplingRule(SamplingRuleProperty.builder()
                         .attributes(Map.of(
                                 "attributesKey", "attributes"))
                         .fixedRate(123)
                         .host("host")
                         .httpMethod("httpMethod")
                         .priority(123)
                         .reservoirSize(123)
                         .resourceArn("resourceArn")
                         .ruleArn("ruleArn")
                         .ruleName("ruleName")
                         .serviceName("serviceName")
                         .serviceType("serviceType")
                         .urlPath("urlPath")
                         .version(123)
                         .build())
                 .build())
         .samplingRuleUpdate(SamplingRuleUpdateProperty.builder()
                 .attributes(Map.of(
                         "attributesKey", "attributes"))
                 .fixedRate(123)
                 .host("host")
                 .httpMethod("httpMethod")
                 .priority(123)
                 .reservoirSize(123)
                 .resourceArn("resourceArn")
                 .ruleArn("ruleArn")
                 .ruleName("ruleName")
                 .serviceName("serviceName")
                 .serviceType("serviceType")
                 .urlPath("urlPath")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSamplingRuleMixinProps.Builder	A builder for CfnSamplingRuleMixinProps
static final class	CfnSamplingRuleMixinProps.Jsii$Proxy	An implementation for CfnSamplingRuleMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnSamplingRuleMixinProps.Builder	builder()
default String	getRuleName()	Deprecated. this property has been deprecated
default Object	getSamplingRule()	The sampling rule to be created or updated.
default Object	getSamplingRuleRecord()	Deprecated. this property has been deprecated
default Object	getSamplingRuleUpdate()	Deprecated. this property has been deprecated
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRuleName

@Stability(Deprecated)
@Deprecated
@Nullable
default String getRuleName()

Deprecated.

this property has been deprecated

(deprecated) The ARN of the sampling rule.

Specify a rule by either name or ARN, but not both.

See Also:

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

getSamplingRule

@Stability(Stable)
@Nullable
default Object getSamplingRule()

The sampling rule to be created or updated.

Returns union: either IResolvable or CfnSamplingRulePropsMixin.SamplingRuleProperty

See Also:

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

getSamplingRuleRecord

@Stability(Deprecated)
@Deprecated
@Nullable
default Object getSamplingRuleRecord()

Deprecated.

this property has been deprecated

Returns union: either IResolvable or CfnSamplingRulePropsMixin.SamplingRuleRecordProperty

See Also:

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

getSamplingRuleUpdate

@Stability(Deprecated)
@Deprecated
@Nullable
default Object getSamplingRuleUpdate()

Deprecated.

this property has been deprecated

Returns union: either IResolvable or CfnSamplingRulePropsMixin.SamplingRuleUpdateProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnSamplingRuleMixinProps.Builder builder()

Returns:

a CfnSamplingRuleMixinProps.Builder of CfnSamplingRuleMixinProps