Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. xray
  5. SamplingRule
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.xray.SamplingRule

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Creates and manages an AWS XRay Sampling Rule.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.xray.SamplingRule("example", {
    ruleName: "example",
    priority: 9999,
    version: 1,
    reservoirSize: 1,
    fixedRate: 0.05,
    urlPath: "*",
    host: "*",
    httpMethod: "*",
    serviceType: "*",
    serviceName: "*",
    resourceArn: "*",
    attributes: {
        Hello: "Tris",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.xray.SamplingRule("example",
    rule_name="example",
    priority=9999,
    version=1,
    reservoir_size=1,
    fixed_rate=0.05,
    url_path="*",
    host="*",
    http_method="*",
    service_type="*",
    service_name="*",
    resource_arn="*",
    attributes={
        "Hello": "Tris",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/xray"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := xray.NewSamplingRule(ctx, "example", &xray.SamplingRuleArgs{
			RuleName:      pulumi.String("example"),
			Priority:      pulumi.Int(9999),
			Version:       pulumi.Int(1),
			ReservoirSize: pulumi.Int(1),
			FixedRate:     pulumi.Float64(0.05),
			UrlPath:       pulumi.String("*"),
			Host:          pulumi.String("*"),
			HttpMethod:    pulumi.String("*"),
			ServiceType:   pulumi.String("*"),
			ServiceName:   pulumi.String("*"),
			ResourceArn:   pulumi.String("*"),
			Attributes: pulumi.StringMap{
				"Hello": pulumi.String("Tris"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Xray.SamplingRule("example", new()
    {
        RuleName = "example",
        Priority = 9999,
        Version = 1,
        ReservoirSize = 1,
        FixedRate = 0.05,
        UrlPath = "*",
        Host = "*",
        HttpMethod = "*",
        ServiceType = "*",
        ServiceName = "*",
        ResourceArn = "*",
        Attributes = 
        {
            { "Hello", "Tris" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.xray.SamplingRule;
import com.pulumi.aws.xray.SamplingRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new SamplingRule("example", SamplingRuleArgs.builder()
            .ruleName("example")
            .priority(9999)
            .version(1)
            .reservoirSize(1)
            .fixedRate(0.05)
            .urlPath("*")
            .host("*")
            .httpMethod("*")
            .serviceType("*")
            .serviceName("*")
            .resourceArn("*")
            .attributes(Map.of("Hello", "Tris"))
            .build());

    }
}
Copy
resources:
  example:
    type: aws:xray:SamplingRule
    properties:
      ruleName: example
      priority: 9999
      version: 1
      reservoirSize: 1
      fixedRate: 0.05
      urlPath: '*'
      host: '*'
      httpMethod: '*'
      serviceType: '*'
      serviceName: '*'
      resourceArn: '*'
      attributes:
        Hello: Tris
Copy

Create SamplingRule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SamplingRule(name: string, args: SamplingRuleArgs, opts?: CustomResourceOptions);
@overload
def SamplingRule(resource_name: str,
                 args: SamplingRuleArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def SamplingRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 resource_arn: Optional[str] = None,
                 fixed_rate: Optional[float] = None,
                 host: Optional[str] = None,
                 http_method: Optional[str] = None,
                 priority: Optional[int] = None,
                 reservoir_size: Optional[int] = None,
                 service_name: Optional[str] = None,
                 service_type: Optional[str] = None,
                 url_path: Optional[str] = None,
                 version: Optional[int] = None,
                 attributes: Optional[Mapping[str, str]] = None,
                 rule_name: Optional[str] = None,
                 tags: Optional[Mapping[str, str]] = None)
func NewSamplingRule(ctx *Context, name string, args SamplingRuleArgs, opts ...ResourceOption) (*SamplingRule, error)
public SamplingRule(string name, SamplingRuleArgs args, CustomResourceOptions? opts = null)
public SamplingRule(String name, SamplingRuleArgs args)
public SamplingRule(String name, SamplingRuleArgs args, CustomResourceOptions options)

type: aws:xray:SamplingRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SamplingRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SamplingRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SamplingRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SamplingRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SamplingRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var samplingRuleResource = new Aws.Xray.SamplingRule("samplingRuleResource", new()
{
    ResourceArn = "string",
    FixedRate = 0,
    Host = "string",
    HttpMethod = "string",
    Priority = 0,
    ReservoirSize = 0,
    ServiceName = "string",
    ServiceType = "string",
    UrlPath = "string",
    Version = 0,
    Attributes = 
    {
        { "string", "string" },
    },
    RuleName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := xray.NewSamplingRule(ctx, "samplingRuleResource", &xray.SamplingRuleArgs{
	ResourceArn:   pulumi.String("string"),
	FixedRate:     pulumi.Float64(0),
	Host:          pulumi.String("string"),
	HttpMethod:    pulumi.String("string"),
	Priority:      pulumi.Int(0),
	ReservoirSize: pulumi.Int(0),
	ServiceName:   pulumi.String("string"),
	ServiceType:   pulumi.String("string"),
	UrlPath:       pulumi.String("string"),
	Version:       pulumi.Int(0),
	Attributes: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	RuleName: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var samplingRuleResource = new SamplingRule("samplingRuleResource", SamplingRuleArgs.builder()
    .resourceArn("string")
    .fixedRate(0)
    .host("string")
    .httpMethod("string")
    .priority(0)
    .reservoirSize(0)
    .serviceName("string")
    .serviceType("string")
    .urlPath("string")
    .version(0)
    .attributes(Map.of("string", "string"))
    .ruleName("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
sampling_rule_resource = aws.xray.SamplingRule("samplingRuleResource",
    resource_arn="string",
    fixed_rate=0,
    host="string",
    http_method="string",
    priority=0,
    reservoir_size=0,
    service_name="string",
    service_type="string",
    url_path="string",
    version=0,
    attributes={
        "string": "string",
    },
    rule_name="string",
    tags={
        "string": "string",
    })
Copy
const samplingRuleResource = new aws.xray.SamplingRule("samplingRuleResource", {
    resourceArn: "string",
    fixedRate: 0,
    host: "string",
    httpMethod: "string",
    priority: 0,
    reservoirSize: 0,
    serviceName: "string",
    serviceType: "string",
    urlPath: "string",
    version: 0,
    attributes: {
        string: "string",
    },
    ruleName: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:xray:SamplingRule
properties:
    attributes:
        string: string
    fixedRate: 0
    host: string
    httpMethod: string
    priority: 0
    reservoirSize: 0
    resourceArn: string
    ruleName: string
    serviceName: string
    serviceType: string
    tags:
        string: string
    urlPath: string
    version: 0
Copy

SamplingRule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SamplingRule resource accepts the following input properties:

FixedRate This property is required. double
The percentage of matching requests to instrument, after the reservoir is exhausted.
Host This property is required. string
Matches the hostname from a request URL.
HttpMethod This property is required. string
Matches the HTTP method of a request.
Priority This property is required. int
The priority of the sampling rule.
ReservoirSize This property is required. int
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
ResourceArn This property is required. string
Matches the ARN of the AWS resource on which the service runs.
ServiceName This property is required. string
Matches the name that the service uses to identify itself in segments.
ServiceType This property is required. string
Matches the origin that the service uses to identify its type in segments.
UrlPath This property is required. string
Matches the path from a request URL.
Version
This property is required.
Changes to this property will trigger replacement.
int
The version of the sampling rule format (1 )
Attributes Dictionary<string, string>
Matches attributes derived from the request.
RuleName Changes to this property will trigger replacement. string
The name of the sampling rule.
Tags Dictionary<string, string>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
FixedRate This property is required. float64
The percentage of matching requests to instrument, after the reservoir is exhausted.
Host This property is required. string
Matches the hostname from a request URL.
HttpMethod This property is required. string
Matches the HTTP method of a request.
Priority This property is required. int
The priority of the sampling rule.
ReservoirSize This property is required. int
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
ResourceArn This property is required. string
Matches the ARN of the AWS resource on which the service runs.
ServiceName This property is required. string
Matches the name that the service uses to identify itself in segments.
ServiceType This property is required. string
Matches the origin that the service uses to identify its type in segments.
UrlPath This property is required. string
Matches the path from a request URL.
Version
This property is required.
Changes to this property will trigger replacement.
int
The version of the sampling rule format (1 )
Attributes map[string]string
Matches attributes derived from the request.
RuleName Changes to this property will trigger replacement. string
The name of the sampling rule.
Tags map[string]string
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
fixedRate This property is required. Double
The percentage of matching requests to instrument, after the reservoir is exhausted.
host This property is required. String
Matches the hostname from a request URL.
httpMethod This property is required. String
Matches the HTTP method of a request.
priority This property is required. Integer
The priority of the sampling rule.
reservoirSize This property is required. Integer
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resourceArn This property is required. String
Matches the ARN of the AWS resource on which the service runs.
serviceName This property is required. String
Matches the name that the service uses to identify itself in segments.
serviceType This property is required. String
Matches the origin that the service uses to identify its type in segments.
urlPath This property is required. String
Matches the path from a request URL.
version
This property is required.
Changes to this property will trigger replacement.
Integer
The version of the sampling rule format (1 )
attributes Map<String,String>
Matches attributes derived from the request.
ruleName Changes to this property will trigger replacement. String
The name of the sampling rule.
tags Map<String,String>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
fixedRate This property is required. number
The percentage of matching requests to instrument, after the reservoir is exhausted.
host This property is required. string
Matches the hostname from a request URL.
httpMethod This property is required. string
Matches the HTTP method of a request.
priority This property is required. number
The priority of the sampling rule.
reservoirSize This property is required. number
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resourceArn This property is required. string
Matches the ARN of the AWS resource on which the service runs.
serviceName This property is required. string
Matches the name that the service uses to identify itself in segments.
serviceType This property is required. string
Matches the origin that the service uses to identify its type in segments.
urlPath This property is required. string
Matches the path from a request URL.
version
This property is required.
Changes to this property will trigger replacement.
number
The version of the sampling rule format (1 )
attributes {[key: string]: string}
Matches attributes derived from the request.
ruleName Changes to this property will trigger replacement. string
The name of the sampling rule.
tags {[key: string]: string}
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
fixed_rate This property is required. float
The percentage of matching requests to instrument, after the reservoir is exhausted.
host This property is required. str
Matches the hostname from a request URL.
http_method This property is required. str
Matches the HTTP method of a request.
priority This property is required. int
The priority of the sampling rule.
reservoir_size This property is required. int
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resource_arn This property is required. str
Matches the ARN of the AWS resource on which the service runs.
service_name This property is required. str
Matches the name that the service uses to identify itself in segments.
service_type This property is required. str
Matches the origin that the service uses to identify its type in segments.
url_path This property is required. str
Matches the path from a request URL.
version
This property is required.
Changes to this property will trigger replacement.
int
The version of the sampling rule format (1 )
attributes Mapping[str, str]
Matches attributes derived from the request.
rule_name Changes to this property will trigger replacement. str
The name of the sampling rule.
tags Mapping[str, str]
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
fixedRate This property is required. Number
The percentage of matching requests to instrument, after the reservoir is exhausted.
host This property is required. String
Matches the hostname from a request URL.
httpMethod This property is required. String
Matches the HTTP method of a request.
priority This property is required. Number
The priority of the sampling rule.
reservoirSize This property is required. Number
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resourceArn This property is required. String
Matches the ARN of the AWS resource on which the service runs.
serviceName This property is required. String
Matches the name that the service uses to identify itself in segments.
serviceType This property is required. String
Matches the origin that the service uses to identify its type in segments.
urlPath This property is required. String
Matches the path from a request URL.
version
This property is required.
Changes to this property will trigger replacement.
Number
The version of the sampling rule format (1 )
attributes Map<String>
Matches attributes derived from the request.
ruleName Changes to this property will trigger replacement. String
The name of the sampling rule.
tags Map<String>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

Outputs

All input properties are implicitly available as output properties. Additionally, the SamplingRule resource produces the following output properties:

Arn string
The ARN of the sampling rule.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN of the sampling rule.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the sampling rule.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN of the sampling rule.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN of the sampling rule.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the sampling rule.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing SamplingRule Resource

Get an existing SamplingRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SamplingRuleState, opts?: CustomResourceOptions): SamplingRule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        attributes: Optional[Mapping[str, str]] = None,
        fixed_rate: Optional[float] = None,
        host: Optional[str] = None,
        http_method: Optional[str] = None,
        priority: Optional[int] = None,
        reservoir_size: Optional[int] = None,
        resource_arn: Optional[str] = None,
        rule_name: Optional[str] = None,
        service_name: Optional[str] = None,
        service_type: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        url_path: Optional[str] = None,
        version: Optional[int] = None) -> SamplingRule
func GetSamplingRule(ctx *Context, name string, id IDInput, state *SamplingRuleState, opts ...ResourceOption) (*SamplingRule, error)
public static SamplingRule Get(string name, Input<string> id, SamplingRuleState? state, CustomResourceOptions? opts = null)
public static SamplingRule get(String name, Output<String> id, SamplingRuleState state, CustomResourceOptions options)
resources:  _:    type: aws:xray:SamplingRule    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
The ARN of the sampling rule.
Attributes Dictionary<string, string>
Matches attributes derived from the request.
FixedRate double
The percentage of matching requests to instrument, after the reservoir is exhausted.
Host string
Matches the hostname from a request URL.
HttpMethod string
Matches the HTTP method of a request.
Priority int
The priority of the sampling rule.
ReservoirSize int
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
ResourceArn string
Matches the ARN of the AWS resource on which the service runs.
RuleName Changes to this property will trigger replacement. string
The name of the sampling rule.
ServiceName string
Matches the name that the service uses to identify itself in segments.
ServiceType string
Matches the origin that the service uses to identify its type in segments.
Tags Dictionary<string, string>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UrlPath string
Matches the path from a request URL.
Version Changes to this property will trigger replacement. int
The version of the sampling rule format (1 )
Arn string
The ARN of the sampling rule.
Attributes map[string]string
Matches attributes derived from the request.
FixedRate float64
The percentage of matching requests to instrument, after the reservoir is exhausted.
Host string
Matches the hostname from a request URL.
HttpMethod string
Matches the HTTP method of a request.
Priority int
The priority of the sampling rule.
ReservoirSize int
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
ResourceArn string
Matches the ARN of the AWS resource on which the service runs.
RuleName Changes to this property will trigger replacement. string
The name of the sampling rule.
ServiceName string
Matches the name that the service uses to identify itself in segments.
ServiceType string
Matches the origin that the service uses to identify its type in segments.
Tags map[string]string
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UrlPath string
Matches the path from a request URL.
Version Changes to this property will trigger replacement. int
The version of the sampling rule format (1 )
arn String
The ARN of the sampling rule.
attributes Map<String,String>
Matches attributes derived from the request.
fixedRate Double
The percentage of matching requests to instrument, after the reservoir is exhausted.
host String
Matches the hostname from a request URL.
httpMethod String
Matches the HTTP method of a request.
priority Integer
The priority of the sampling rule.
reservoirSize Integer
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resourceArn String
Matches the ARN of the AWS resource on which the service runs.
ruleName Changes to this property will trigger replacement. String
The name of the sampling rule.
serviceName String
Matches the name that the service uses to identify itself in segments.
serviceType String
Matches the origin that the service uses to identify its type in segments.
tags Map<String,String>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

urlPath String
Matches the path from a request URL.
version Changes to this property will trigger replacement. Integer
The version of the sampling rule format (1 )
arn string
The ARN of the sampling rule.
attributes {[key: string]: string}
Matches attributes derived from the request.
fixedRate number
The percentage of matching requests to instrument, after the reservoir is exhausted.
host string
Matches the hostname from a request URL.
httpMethod string
Matches the HTTP method of a request.
priority number
The priority of the sampling rule.
reservoirSize number
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resourceArn string
Matches the ARN of the AWS resource on which the service runs.
ruleName Changes to this property will trigger replacement. string
The name of the sampling rule.
serviceName string
Matches the name that the service uses to identify itself in segments.
serviceType string
Matches the origin that the service uses to identify its type in segments.
tags {[key: string]: string}
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

urlPath string
Matches the path from a request URL.
version Changes to this property will trigger replacement. number
The version of the sampling rule format (1 )
arn str
The ARN of the sampling rule.
attributes Mapping[str, str]
Matches attributes derived from the request.
fixed_rate float
The percentage of matching requests to instrument, after the reservoir is exhausted.
host str
Matches the hostname from a request URL.
http_method str
Matches the HTTP method of a request.
priority int
The priority of the sampling rule.
reservoir_size int
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resource_arn str
Matches the ARN of the AWS resource on which the service runs.
rule_name Changes to this property will trigger replacement. str
The name of the sampling rule.
service_name str
Matches the name that the service uses to identify itself in segments.
service_type str
Matches the origin that the service uses to identify its type in segments.
tags Mapping[str, str]
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

url_path str
Matches the path from a request URL.
version Changes to this property will trigger replacement. int
The version of the sampling rule format (1 )
arn String
The ARN of the sampling rule.
attributes Map<String>
Matches attributes derived from the request.
fixedRate Number
The percentage of matching requests to instrument, after the reservoir is exhausted.
host String
Matches the hostname from a request URL.
httpMethod String
Matches the HTTP method of a request.
priority Number
The priority of the sampling rule.
reservoirSize Number
A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.
resourceArn String
Matches the ARN of the AWS resource on which the service runs.
ruleName Changes to this property will trigger replacement. String
The name of the sampling rule.
serviceName String
Matches the name that the service uses to identify itself in segments.
serviceType String
Matches the origin that the service uses to identify its type in segments.
tags Map<String>
Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

urlPath String
Matches the path from a request URL.
version Changes to this property will trigger replacement. Number
The version of the sampling rule format (1 )

Import

Using pulumi import, import XRay Sampling Rules using the name. For example:

$ pulumi import aws:xray/samplingRule:SamplingRule example example
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws