AWS::XRay::SamplingRule

XRay SamplingRule

This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.

Properties

5 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`RuleName`	`string`	Deprecated
`SamplingRule`	`SamplingRule`
`SamplingRuleRecord`	`SamplingRuleRecord`	Deprecated
`SamplingRuleUpdate`	`SamplingRuleUpdate`	Deprecated
`Tags`	`array`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`RuleARN`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::XRay::SamplingRule

Resources:
  MyResource:
    Type: AWS::XRay::SamplingRule
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

xray:CreateSamplingRulexray:TagResourcexray:ListTagsForResource

read

xray:GetSamplingRulesxray:ListTagsForResource

update

xray:UpdateSamplingRulexray:TagResourcexray:UntagResourcexray:ListTagsForResource

delete

xray:DeleteSamplingRule

list

xray:GetSamplingRulesxray:ListTagsForResource

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceXRay

Properties6

Required0

TaggingSupported

Primary IDRuleARN

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

SamplingRule/Version

Related Resources

External Links

AWS Documentation