Package software.amazon.awscdk.services.xray

Interface CfnSamplingRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSamplingRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:26.065Z")
@Stability(Stable)
public interface CfnSamplingRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSamplingRule.

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.*;
 CfnSamplingRuleProps cfnSamplingRuleProps = CfnSamplingRuleProps.builder()
         .ruleName("ruleName")
         .samplingRule(SamplingRuleProperty.builder()
                 .fixedRate(123)
                 .host("host")
                 .httpMethod("httpMethod")
                 .priority(123)
                 .reservoirSize(123)
                 .resourceArn("resourceArn")
                 .serviceName("serviceName")
                 .serviceType("serviceType")
                 .urlPath("urlPath")
                 // the properties below are optional
                 .attributes(Map.of(
                         "attributesKey", "attributes"))
                 .ruleArn("ruleArn")
                 .ruleName("ruleName")
                 .version(123)
                 .build())
         .samplingRuleRecord(SamplingRuleRecordProperty.builder()
                 .createdAt("createdAt")
                 .modifiedAt("modifiedAt")
                 .samplingRule(SamplingRuleProperty.builder()
                         .fixedRate(123)
                         .host("host")
                         .httpMethod("httpMethod")
                         .priority(123)
                         .reservoirSize(123)
                         .resourceArn("resourceArn")
                         .serviceName("serviceName")
                         .serviceType("serviceType")
                         .urlPath("urlPath")
                         // the properties below are optional
                         .attributes(Map.of(
                                 "attributesKey", "attributes"))
                         .ruleArn("ruleArn")
                         .ruleName("ruleName")
                         .version(123)
                         .build())
                 .build())
         .samplingRuleUpdate(SamplingRuleUpdateProperty.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")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnSamplingRuleProps.Builder	builder()
default String	getRuleName()	Deprecated. this property has been deprecated
default Object	getSamplingRule()	The sampling rule to be created or updated.
default Object	getSamplingRuleRecord()	Deprecated. this property has been deprecated
default Object	getSamplingRuleUpdate()	Deprecated. this property has been deprecated
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRuleName

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

Deprecated.

this property has been deprecated

(deprecated) The ARN 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-resource-xray-samplingrule.html#cfn-xray-samplingrule-rulename

getSamplingRule

@Stability(Stable)
@Nullable
default Object getSamplingRule()

The sampling rule to be created or updated.

See Also:

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

getSamplingRuleRecord

@Stability(Deprecated)
@Deprecated
@Nullable
default Object getSamplingRuleRecord()

Deprecated.

this property has been deprecated

See Also:

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

getSamplingRuleUpdate

@Stability(Deprecated)
@Deprecated
@Nullable
default Object getSamplingRuleUpdate()

Deprecated.

this property has been deprecated

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

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

builder

@Stability(Stable)
static CfnSamplingRuleProps.Builder builder()

Returns:

a CfnSamplingRuleProps.Builder of CfnSamplingRuleProps