interface CfnSamplingRuleProps

Language	Type name
.NET	Amazon.CDK.AWS.XRay.CfnSamplingRuleProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsxray#CfnSamplingRuleProps
Java	software.amazon.awscdk.services.xray.CfnSamplingRuleProps
Python	aws_cdk.aws_xray.CfnSamplingRuleProps
TypeScript	aws-cdk-lib » aws_xray » CfnSamplingRuleProps

Properties for defining a CfnSamplingRule.

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-lib';
const cfnSamplingRuleProps: xray.CfnSamplingRuleProps = {
  ruleName: 'ruleName',
  samplingRule: {
    fixedRate: 123,
    host: 'host',
    httpMethod: 'httpMethod',
    priority: 123,
    reservoirSize: 123,
    resourceArn: 'resourceArn',
    serviceName: 'serviceName',
    serviceType: 'serviceType',
    urlPath: 'urlPath',

    // the properties below are optional
    attributes: {
      attributesKey: 'attributes',
    },
    ruleArn: 'ruleArn',
    ruleName: 'ruleName',
    version: 123,
  },
  samplingRuleRecord: {
    createdAt: 'createdAt',
    modifiedAt: 'modifiedAt',
    samplingRule: {
      fixedRate: 123,
      host: 'host',
      httpMethod: 'httpMethod',
      priority: 123,
      reservoirSize: 123,
      resourceArn: 'resourceArn',
      serviceName: 'serviceName',
      serviceType: 'serviceType',
      urlPath: 'urlPath',

      // the properties below are optional
      attributes: {
        attributesKey: 'attributes',
      },
      ruleArn: 'ruleArn',
      ruleName: 'ruleName',
      version: 123,
    },
  },
  samplingRuleUpdate: {
    attributes: {
      attributesKey: 'attributes',
    },
    fixedRate: 123,
    host: 'host',
    httpMethod: 'httpMethod',
    priority: 123,
    reservoirSize: 123,
    resourceArn: 'resourceArn',
    ruleArn: 'ruleArn',
    ruleName: 'ruleName',
    serviceName: 'serviceName',
    serviceType: 'serviceType',
    urlPath: 'urlPath',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
ruleName?⚠️	string	The ARN of the sampling rule.
samplingRule?	IResolvable | SamplingRuleProperty	The sampling rule to be created or updated.
samplingRuleRecord?⚠️	IResolvable | SamplingRuleRecordProperty
samplingRuleUpdate?⚠️	IResolvable | SamplingRuleUpdateProperty
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.

---

ruleName?⚠️

⚠️ Deprecated: this property has been deprecated

Type: string (optional)

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

---

samplingRule?

Type: IResolvable | SamplingRuleProperty (optional)

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

---

samplingRuleRecord?⚠️

⚠️ Deprecated: this property has been deprecated

Type: IResolvable | SamplingRuleRecordProperty (optional)

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

---

samplingRuleUpdate?⚠️

⚠️ Deprecated: this property has been deprecated

Type: IResolvable | SamplingRuleUpdateProperty (optional)

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

---

tags?

Type: CfnTag[] (optional)

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