software.amazon.awscdk.services.xray

Interface CfnSamplingRuleProps

All Known Implementing Classes:

CfnSamplingRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-02T20:25:28.493Z")
public interface CfnSamplingRuleProps

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 java.lang.String	getRuleName() The name of the sampling rule.
default java.lang.Object	getSamplingRule() The sampling rule to be created.
default java.lang.Object	getSamplingRuleRecord() `AWS::XRay::SamplingRule.SamplingRuleRecord`.
default java.lang.Object	getSamplingRuleUpdate() A document specifying changes to a sampling rule's configuration.
default java.util.List<java.lang.Object>	getTags() An array of key-value pairs to apply to this resource.

Method Detail

getRuleName

default java.lang.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

default java.lang.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

default java.lang.Object getSamplingRuleRecord()

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

getSamplingRuleUpdate

default java.lang.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

default java.util.List<java.lang.Object> getTags()

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

For more information, see Tag .

builder

static CfnSamplingRuleProps.Builder builder()

Returns:

a CfnSamplingRuleProps.Builder of CfnSamplingRuleProps