AWS::XRay::SamplingRule SamplingRateBoost - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::XRay::SamplingRule SamplingRateBoost

Enable temporary sampling rate increases when you detect anomalies to improve visibility.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "CooldownWindowMinutes" : Integer,
  "MaxRate" : Number
}

YAML

  CooldownWindowMinutes: Integer
  MaxRate: Number

Properties

CooldownWindowMinutes

Sets the 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.

Required: Yes

Type: Integer

Minimum: 1

Update requires: No interruption

MaxRate

Defines max temporary sampling rate to apply when a boost is triggered. Calculated boost rate by X-Ray will be less than or equal to this max rate.

Required: Yes

Type: Number

Minimum: 0

Maximum: 1

Update requires: No interruption