software.amazon.awscdk.services.xray

Interface CfnSamplingRule.SamplingRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSamplingRule.SamplingRuleProperty.Jsii$Proxy

Enclosing class:

CfnSamplingRule

@Stability(value=Stable)
public static interface CfnSamplingRule.SamplingRuleProperty
extends software.amazon.jsii.JsiiSerializable

A sampling rule that services use to decide whether to instrument a request.

Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

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.*;
 SamplingRuleProperty samplingRuleProperty = 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnSamplingRule.SamplingRuleProperty.Builder	builder()
default Object	getAttributes() Matches attributes derived from the request.
default Number	getFixedRate() The percentage of matching requests to instrument, after the reservoir is exhausted.
default String	getHost() Matches the hostname from a request URL.
default String	getHttpMethod() Matches the HTTP method of a request.
default Number	getPriority() The priority of the sampling rule.
default Number	getReservoirSize() A fixed number of matching requests to instrument per second, prior to applying the fixed rate.
default String	getResourceArn() Matches the ARN of the AWS resource on which the service runs.
default String	getRuleArn() The ARN of the sampling rule.
default String	getRuleName() The name of the sampling rule.
default String	getServiceName() Matches the `name` that the service uses to identify itself in segments.
default String	getServiceType() Matches the `origin` that the service uses to identify its type in segments.
default String	getUrlPath() Matches the path from a request URL.
default Number	getVersion() The version of the sampling rule format ( `1` ).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttributes

@Stability(value=Stable)
 @Nullable
default Object getAttributes()

Matches attributes derived from the request.

Map Entries: Maximum number of 5 items.

Key Length Constraints: Minimum length of 1. Maximum length of 32.

Value Length Constraints: Minimum length of 1. Maximum length of 32.

getFixedRate

@Stability(value=Stable)
 @Nullable
default Number getFixedRate()

The percentage of matching requests to instrument, after the reservoir is exhausted.

getHost

@Stability(value=Stable)
 @Nullable
default String getHost()

Matches the hostname from a request URL.

getHttpMethod

@Stability(value=Stable)
 @Nullable
default String getHttpMethod()

Matches the HTTP method of a request.

getPriority

@Stability(value=Stable)
 @Nullable
default Number getPriority()

The priority of the sampling rule.

getReservoirSize

@Stability(value=Stable)
 @Nullable
default Number getReservoirSize()

A fixed number of matching requests to instrument per second, prior to applying the fixed rate.

The reservoir is not used directly by services, but applies to all services using the rule collectively.

getResourceArn

@Stability(value=Stable)
 @Nullable
default String getResourceArn()

Matches the ARN of the AWS resource on which the service runs.

getRuleArn

@Stability(value=Stable)
 @Nullable
default String getRuleArn()

The ARN of the sampling rule.

You must specify either RuleARN or RuleName, but not both.

getRuleName

@Stability(value=Stable)
 @Nullable
default String getRuleName()

The name of the sampling rule.

You must specify either RuleARN or RuleName, but not both.

getServiceName

@Stability(value=Stable)
 @Nullable
default String getServiceName()

Matches the `name` that the service uses to identify itself in segments.

getServiceType

@Stability(value=Stable)
 @Nullable
default String getServiceType()

Matches the `origin` that the service uses to identify its type in segments.

getUrlPath

@Stability(value=Stable)
 @Nullable
default String getUrlPath()

Matches the path from a request URL.

getVersion

@Stability(value=Stable)
 @Nullable
default Number getVersion()

The version of the sampling rule format ( `1` ).

builder

@Stability(value=Stable)
static CfnSamplingRule.SamplingRuleProperty.Builder builder()

Returns:

a CfnSamplingRule.SamplingRuleProperty.Builder of CfnSamplingRule.SamplingRuleProperty