Package software.amazon.awscdk.cfnpropertymixins.services.xray

Interface CfnSamplingRulePropsMixin.SamplingRuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSamplingRulePropsMixin.SamplingRuleProperty.Jsii$Proxy

Enclosing class:

CfnSamplingRulePropsMixin

@Stability(Stable)
public static interface CfnSamplingRulePropsMixin.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.cfnpropertymixins.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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSamplingRulePropsMixin.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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributes

@Stability(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.

Returns union: either Mapinvalid input: '<'String, String> or IResolvable

See Also:

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

getFixedRate

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

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

See Also:

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

getHost

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

Matches the hostname from a request URL.

See Also:

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

getHttpMethod

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

Matches the HTTP method of a request.

See Also:

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

getPriority

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

The priority of the sampling rule.

See Also:

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

getReservoirSize

@Stability(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.

See Also:

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

getResourceArn

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

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

See Also:

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

getRuleArn

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

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.

See Also:

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

getRuleName

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

The name of the sampling rule.

Specify a rule by either name or ARN, but not both.

See Also:

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

getServiceName

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

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

See Also:

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

getServiceType

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

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

See Also:

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

getUrlPath

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

Matches the path from a request URL.

See Also:

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

getVersion

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

The version of the sampling rule.

Version can only be set when creating a new sampling rule.

See Also:

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

builder

@Stability(Stable)
static CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder builder()

Returns:

a CfnSamplingRulePropsMixin.SamplingRuleProperty.Builder of CfnSamplingRulePropsMixin.SamplingRuleProperty