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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.848Z")
 @Stability(value=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.*;
 Object tags;
 CfnSamplingRuleProps cfnSamplingRuleProps = CfnSamplingRuleProps.builder()
         .ruleName("ruleName")
         .samplingRule(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())
         .samplingRuleRecord(SamplingRuleRecordProperty.builder()
                 .createdAt("createdAt")
                 .modifiedAt("modifiedAt")
                 .samplingRule(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())
                 .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(tags))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnSamplingRuleProps.Builder	builder()
default String	getRuleName() The name of the sampling rule.
default Object	getSamplingRule() The sampling rule to be created.
default Object	getSamplingRuleRecord() `AWS::XRay::SamplingRule.SamplingRuleRecord`.
default Object	getSamplingRuleUpdate() A document specifying changes to a sampling rule's configuration.
default List<Object>	getTags() An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRuleName

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

The name of the sampling rule.

Specify a rule by either name or ARN, but not both. Used only when deleting a sampling rule. When creating or updating a sampling rule, use the RuleName or RuleARN properties within SamplingRule or SamplingRuleUpdate .

getSamplingRule

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

The sampling rule to be created.

Must be provided if creating a new sampling rule. Not valid when updating an existing sampling rule.

getSamplingRuleRecord

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

`AWS::XRay::SamplingRule.SamplingRuleRecord`.

getSamplingRuleUpdate

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

A document specifying changes to a sampling rule's configuration.

Must be provided if updating an existing sampling rule. Not valid when creating a new sampling rule.

The Version of a sampling rule cannot be updated, and is not part of SamplingRuleUpdate .

getTags

@Stability(value=Stable)
 @Nullable
default List<Object> getTags()

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

For more information, see Tag .

builder

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

Returns:

a CfnSamplingRuleProps.Builder of CfnSamplingRuleProps