Skip to content
v2.277.0

SamplingRateBoostProperty Struct ​

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_xray as xray } from 'aws-cdk-lib';
const samplingRateBoostProperty: xray.CfnSamplingRule.SamplingRateBoostProperty = {
  cooldownWindowMinutes: 123,
  maxRate: 123,
};
python
# 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

sampling_rate_boost_property = xray.CfnSamplingRule.SamplingRateBoostProperty(
    cooldown_window_minutes=123,
    max_rate=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.xray.*;

SamplingRateBoostProperty samplingRateBoostProperty = SamplingRateBoostProperty.builder()
        .cooldownWindowMinutes(123)
        .maxRate(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.XRay;

var samplingRateBoostProperty = new SamplingRateBoostProperty {
    CooldownWindowMinutes = 123,
    MaxRate = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

samplingRateBoostProperty := &SamplingRateBoostProperty{
	CooldownWindowMinutes: jsii.Number(123),
	MaxRate: jsii.Number(123),
}

Properties ​

cooldownWindowMinutesnumbercooldown_window_minutesint | floatcooldownWindowMinutesNumberCooldownWindowMinutesdoubleCooldownWindowMinutes*float64required#
Time window (in minutes) in which only one sampling rate boost can be triggered.

After a boost occurs, no further boosts are allowed until the next window.

maxRatenumbermax_rateint | floatmaxRateNumberMaxRatedoubleMaxRate*float64required#
The maximum sampling rate X-Ray will apply when it detects anomalies.

X-Ray determines the appropriate rate between your baseline and the maximum, depending on anomaly activity.