class CfnSamplingRulePropsMixin (mixin)

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.XRay.CfnSamplingRulePropsMixin
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsxray#CfnSamplingRulePropsMixin
Java	software.amazon.awscdk.cfnpropertymixins.services.xray.CfnSamplingRulePropsMixin
Python	aws_cdk.cfn_property_mixins.aws_xray.CfnSamplingRulePropsMixin
TypeScript	@aws-cdk/cfn-property-mixins » aws_xray » CfnSamplingRulePropsMixin

Implements IMixin

Extends Mixin

Use the AWS::XRay::SamplingRule resource to specify a sampling rule, which controls sampling behavior for instrumented applications.

Include a SamplingRule entity to create or update a sampling rule.

SamplingRule.Version can only be set when creating a sampling rule. Updating the version will cause the update to fail.

Services retrieve rules with GetSamplingRules , and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_xray as xray } from '@aws-cdk/cfn-property-mixins';
import * as cdk from 'aws-cdk-lib';

declare const mergeStrategy: cdk.IMergeStrategy;
const cfnSamplingRulePropsMixin = new xray.CfnSamplingRulePropsMixin({
  ruleName: 'ruleName',
  samplingRule: {
    attributes: {
      attributesKey: 'attributes',
    },
    fixedRate: 123,
    host: 'host',
    httpMethod: 'httpMethod',
    priority: 123,
    reservoirSize: 123,
    resourceArn: 'resourceArn',
    ruleArn: 'ruleArn',
    ruleName: 'ruleName',
    samplingRateBoost: {
      cooldownWindowMinutes: 123,
      maxRate: 123,
    },
    serviceName: 'serviceName',
    serviceType: 'serviceType',
    urlPath: 'urlPath',
    version: 123,
  },
  samplingRuleRecord: {
    createdAt: 'createdAt',
    modifiedAt: 'modifiedAt',
    samplingRule: {
      attributes: {
        attributesKey: 'attributes',
      },
      fixedRate: 123,
      host: 'host',
      httpMethod: 'httpMethod',
      priority: 123,
      reservoirSize: 123,
      resourceArn: 'resourceArn',
      ruleArn: 'ruleArn',
      ruleName: 'ruleName',
      samplingRateBoost: {
        cooldownWindowMinutes: 123,
        maxRate: 123,
      },
      serviceName: 'serviceName',
      serviceType: 'serviceType',
      urlPath: 'urlPath',
      version: 123,
    },
  },
  samplingRuleUpdate: {
    attributes: {
      attributesKey: 'attributes',
    },
    fixedRate: 123,
    host: 'host',
    httpMethod: 'httpMethod',
    priority: 123,
    reservoirSize: 123,
    resourceArn: 'resourceArn',
    ruleArn: 'ruleArn',
    ruleName: 'ruleName',
    samplingRateBoost: {
      cooldownWindowMinutes: 123,
      maxRate: 123,
    },
    serviceName: 'serviceName',
    serviceType: 'serviceType',
    urlPath: 'urlPath',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mergeStrategy,
});

Initializer

new CfnSamplingRulePropsMixin(props: CfnSamplingRuleMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnSamplingRuleMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::XRay::SamplingRule.

Properties

Name	Type	Description
props	CfnSamplingRuleMixinProps
strategy	IMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnSamplingRuleMixinProps

---

strategy

Type: IMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): void

Parameters

• construct IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.