Package software.amazon.awscdk.services.xray

Interface CfnSamplingRule.SamplingRateBoostProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSamplingRule.SamplingRateBoostProperty.Jsii$Proxy

Enclosing class:

CfnSamplingRule

@Stability(Stable)
public static interface CfnSamplingRule.SamplingRateBoostProperty
extends software.amazon.jsii.JsiiSerializable

Example:

 // 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSamplingRule.SamplingRateBoostProperty.Builder	builder()
Number	getCooldownWindowMinutes()	Time window (in minutes) in which only one sampling rate boost can be triggered.
Number	getMaxRate()	The maximum sampling rate X-Ray will apply when it detects anomalies.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCooldownWindowMinutes

@Stability(Stable)
@NotNull
Number getCooldownWindowMinutes()

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

getMaxRate

@Stability(Stable)
@NotNull
Number getMaxRate()

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

builder

@Stability(Stable)
static CfnSamplingRule.SamplingRateBoostProperty.Builder builder()

Returns:

a CfnSamplingRule.SamplingRateBoostProperty.Builder of CfnSamplingRule.SamplingRateBoostProperty