interface SamplingRateBoostProperty

Language	Type name
.NET	Amazon.CDK.AWS.XRay.CfnSamplingRule.SamplingRateBoostProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsxray#CfnSamplingRule_SamplingRateBoostProperty
Java	software.amazon.awscdk.services.xray.CfnSamplingRule.SamplingRateBoostProperty
Python	aws_cdk.aws_xray.CfnSamplingRule.SamplingRateBoostProperty
TypeScript	aws-cdk-lib » aws_xray » CfnSamplingRule » SamplingRateBoostProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrateboost.html

Example

// 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,
};

Properties

Name	Type	Description
cooldownWindowMinutes	number	Time window (in minutes) in which only one sampling rate boost can be triggered.
maxRate	number	The maximum sampling rate X-Ray will apply when it detects anomalies.

---

cooldownWindowMinutes

Type: number

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrateboost.html#cfn-xray-samplingrule-samplingrateboost-cooldownwindowminutes

---

maxRate

Type: number

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-xray-samplingrule-samplingrateboost.html#cfn-xray-samplingrule-samplingrateboost-maxrate