aws-native logo
AWS Native v0.49.0, Jan 26 23

aws-native.xray.SamplingRule

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

Example Usage

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var samplingRule = new AwsNative.XRay.SamplingRule("samplingRule", new()
    {
        SamplingRuleValue = new AwsNative.XRay.Inputs.SamplingRuleArgs
        {
            RuleName = "MySamplingRule",
            ResourceARN = "*",
            Priority = 2,
            FixedRate = 0.05,
            ReservoirSize = 50,
            ServiceName = "MyServiceName",
            ServiceType = "MyServiceType",
            Host = "MyHost",
            HttpMethod = "GET",
            UrlPath = "*",
            Version = 1,
        },
    });

});

Coming soon!

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

sampling_rule = aws_native.xray.SamplingRule("samplingRule", sampling_rule=aws_native.xray.SamplingRuleArgs(
    rule_name="MySamplingRule",
    resource_arn="*",
    priority=2,
    fixed_rate=0.05,
    reservoir_size=50,
    service_name="MyServiceName",
    service_type="MyServiceType",
    host="MyHost",
    http_method="GET",
    url_path="*",
    version=1,
))
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const samplingRule = new aws_native.xray.SamplingRule("samplingRule", {samplingRule: {
    ruleName: "MySamplingRule",
    resourceARN: "*",
    priority: 2,
    fixedRate: 0.05,
    reservoirSize: 50,
    serviceName: "MyServiceName",
    serviceType: "MyServiceType",
    host: "MyHost",
    httpMethod: "GET",
    urlPath: "*",
    version: 1,
}});

Coming soon!

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var samplingRule = new AwsNative.XRay.SamplingRule("samplingRule", new()
    {
        SamplingRuleValue = new AwsNative.XRay.Inputs.SamplingRuleArgs
        {
            RuleName = "MySamplingRule",
            ResourceARN = "*",
            Priority = 2,
            FixedRate = 0.05,
            ReservoirSize = 50,
            ServiceName = "MyServiceName",
            ServiceType = "MyServiceType",
            Host = "MyHost",
            HttpMethod = "GET",
            UrlPath = "*",
            Version = 1,
        },
    });

});

Coming soon!

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

sampling_rule = aws_native.xray.SamplingRule("samplingRule", sampling_rule=aws_native.xray.SamplingRuleArgs(
    rule_name="MySamplingRule",
    resource_arn="*",
    priority=2,
    fixed_rate=0.05,
    reservoir_size=50,
    service_name="MyServiceName",
    service_type="MyServiceType",
    host="MyHost",
    http_method="GET",
    url_path="*",
    version=1,
))
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const samplingRule = new aws_native.xray.SamplingRule("samplingRule", {samplingRule: {
    ruleName: "MySamplingRule",
    resourceARN: "*",
    priority: 2,
    fixedRate: 0.05,
    reservoirSize: 50,
    serviceName: "MyServiceName",
    serviceType: "MyServiceType",
    host: "MyHost",
    httpMethod: "GET",
    urlPath: "*",
    version: 1,
}});

Coming soon!

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var samplingRule = new AwsNative.XRay.SamplingRule("samplingRule", new()
    {
        SamplingRuleUpdate = new AwsNative.XRay.Inputs.SamplingRuleUpdateArgs
        {
            RuleName = "MySamplingRule",
            ResourceARN = "*",
            Priority = 1,
            FixedRate = 0.07,
            ReservoirSize = 20,
            ServiceName = "MyServiceName",
            ServiceType = "MyServiceType",
            Host = "MyHost",
            HttpMethod = "GET",
            UrlPath = "*",
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := xray.NewSamplingRule(ctx, "samplingRule", &xray.SamplingRuleArgs{
			SamplingRuleUpdate: &xray.SamplingRuleUpdateArgs{
				RuleName:      pulumi.String("MySamplingRule"),
				ResourceARN:   pulumi.String("*"),
				Priority:      pulumi.Int(1),
				FixedRate:     pulumi.Float64(0.07),
				ReservoirSize: pulumi.Int(20),
				ServiceName:   pulumi.String("MyServiceName"),
				ServiceType:   pulumi.String("MyServiceType"),
				Host:          pulumi.String("MyHost"),
				HttpMethod:    pulumi.String("GET"),
				UrlPath:       pulumi.String("*"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

sampling_rule = aws_native.xray.SamplingRule("samplingRule", sampling_rule_update=aws_native.xray.SamplingRuleUpdateArgs(
    rule_name="MySamplingRule",
    resource_arn="*",
    priority=1,
    fixed_rate=0.07,
    reservoir_size=20,
    service_name="MyServiceName",
    service_type="MyServiceType",
    host="MyHost",
    http_method="GET",
    url_path="*",
))
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const samplingRule = new aws_native.xray.SamplingRule("samplingRule", {samplingRuleUpdate: {
    ruleName: "MySamplingRule",
    resourceARN: "*",
    priority: 1,
    fixedRate: 0.07,
    reservoirSize: 20,
    serviceName: "MyServiceName",
    serviceType: "MyServiceType",
    host: "MyHost",
    httpMethod: "GET",
    urlPath: "*",
}});

Coming soon!

Example

using System.Collections.Generic;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var samplingRule = new AwsNative.XRay.SamplingRule("samplingRule", new()
    {
        SamplingRuleUpdate = new AwsNative.XRay.Inputs.SamplingRuleUpdateArgs
        {
            RuleName = "MySamplingRule",
            ResourceARN = "*",
            Priority = 1,
            FixedRate = 0.07,
            ReservoirSize = 20,
            ServiceName = "MyServiceName",
            ServiceType = "MyServiceType",
            Host = "MyHost",
            HttpMethod = "GET",
            UrlPath = "*",
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := xray.NewSamplingRule(ctx, "samplingRule", &xray.SamplingRuleArgs{
			SamplingRuleUpdate: &xray.SamplingRuleUpdateArgs{
				RuleName:      pulumi.String("MySamplingRule"),
				ResourceARN:   pulumi.String("*"),
				Priority:      pulumi.Int(1),
				FixedRate:     pulumi.Float64(0.07),
				ReservoirSize: pulumi.Int(20),
				ServiceName:   pulumi.String("MyServiceName"),
				ServiceType:   pulumi.String("MyServiceType"),
				Host:          pulumi.String("MyHost"),
				HttpMethod:    pulumi.String("GET"),
				UrlPath:       pulumi.String("*"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_aws_native as aws_native

sampling_rule = aws_native.xray.SamplingRule("samplingRule", sampling_rule_update=aws_native.xray.SamplingRuleUpdateArgs(
    rule_name="MySamplingRule",
    resource_arn="*",
    priority=1,
    fixed_rate=0.07,
    reservoir_size=20,
    service_name="MyServiceName",
    service_type="MyServiceType",
    host="MyHost",
    http_method="GET",
    url_path="*",
))
import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const samplingRule = new aws_native.xray.SamplingRule("samplingRule", {samplingRuleUpdate: {
    ruleName: "MySamplingRule",
    resourceARN: "*",
    priority: 1,
    fixedRate: 0.07,
    reservoirSize: 20,
    serviceName: "MyServiceName",
    serviceType: "MyServiceType",
    host: "MyHost",
    httpMethod: "GET",
    urlPath: "*",
}});

Coming soon!

Create SamplingRule Resource

new SamplingRule(name: string, args?: SamplingRuleArgs, opts?: CustomResourceOptions);
@overload
def SamplingRule(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 rule_name: Optional[str] = None,
                 sampling_rule: Optional[SamplingRuleArgs] = None,
                 sampling_rule_record: Optional[SamplingRuleRecordArgs] = None,
                 sampling_rule_update: Optional[SamplingRuleUpdateArgs] = None,
                 tags: Optional[Sequence[TagsItemPropertiesArgs]] = None)
@overload
def SamplingRule(resource_name: str,
                 args: Optional[SamplingRuleInitArgs] = None,
                 opts: Optional[ResourceOptions] = None)
func NewSamplingRule(ctx *Context, name string, args *SamplingRuleArgs, opts ...ResourceOption) (*SamplingRule, error)
public SamplingRule(string name, SamplingRuleArgs? args = null, CustomResourceOptions? opts = null)
public SamplingRule(String name, SamplingRuleArgs args)
public SamplingRule(String name, SamplingRuleArgs args, CustomResourceOptions options)
type: aws-native:xray:SamplingRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

The SamplingRule resource accepts the following input properties:

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

RuleARN string
Id string

The provider-assigned unique ID for this managed resource.

RuleARN string
id String

The provider-assigned unique ID for this managed resource.

ruleARN String
id string

The provider-assigned unique ID for this managed resource.

ruleARN string
id str

The provider-assigned unique ID for this managed resource.

rule_arn str
id String

The provider-assigned unique ID for this managed resource.

ruleARN String

Supporting Types

SamplingRule

Attributes object

Matches attributes derived from the request.

FixedRate double

The percentage of matching requests to instrument, after the reservoir is exhausted.

HTTPMethod string

Matches the HTTP method from a request URL.

Host string

Matches the hostname from a request URL.

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.

RuleARN string
RuleName string
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.

URLPath string

Matches the path from a request URL.

Version int

The version of the sampling rule format (1)

Attributes interface{}

Matches attributes derived from the request.

FixedRate float64

The percentage of matching requests to instrument, after the reservoir is exhausted.

HTTPMethod string

Matches the HTTP method from a request URL.

Host string

Matches the hostname from a request URL.

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.

RuleARN string
RuleName string
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.

URLPath string

Matches the path from a request URL.

Version int

The version of the sampling rule format (1)

attributes Object

Matches attributes derived from the request.

fixedRate Double

The percentage of matching requests to instrument, after the reservoir is exhausted.

hTTPMethod String

Matches the HTTP method from a request URL.

host String

Matches the hostname from a request URL.

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.

ruleARN String
ruleName String
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.

uRLPath String

Matches the path from a request URL.

version Integer

The version of the sampling rule format (1)

attributes any

Matches attributes derived from the request.

fixedRate number

The percentage of matching requests to instrument, after the reservoir is exhausted.

hTTPMethod string

Matches the HTTP method from a request URL.

host string

Matches the hostname from a request URL.

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.

ruleARN string
ruleName string
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.

uRLPath string

Matches the path from a request URL.

version number

The version of the sampling rule format (1)

attributes Any

Matches attributes derived from the request.

fixed_rate float

The percentage of matching requests to instrument, after the reservoir is exhausted.

h_ttp_method str

Matches the HTTP method from a request URL.

host str

Matches the hostname from a request URL.

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_arn str
rule_name str
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.

u_rl_path str

Matches the path from a request URL.

version int

The version of the sampling rule format (1)

attributes Any

Matches attributes derived from the request.

fixedRate Number

The percentage of matching requests to instrument, after the reservoir is exhausted.

hTTPMethod String

Matches the HTTP method from a request URL.

host String

Matches the hostname from a request URL.

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.

ruleARN String
ruleName String
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.

uRLPath String

Matches the path from a request URL.

version Number

The version of the sampling rule format (1)

SamplingRuleRecord

CreatedAt string

When the rule was created, in Unix time seconds.

ModifiedAt string

When the rule was modified, in Unix time seconds.

SamplingRule Pulumi.AwsNative.XRay.Inputs.SamplingRule
CreatedAt string

When the rule was created, in Unix time seconds.

ModifiedAt string

When the rule was modified, in Unix time seconds.

SamplingRule SamplingRuleType
createdAt String

When the rule was created, in Unix time seconds.

modifiedAt String

When the rule was modified, in Unix time seconds.

samplingRule SamplingRule
createdAt string

When the rule was created, in Unix time seconds.

modifiedAt string

When the rule was modified, in Unix time seconds.

samplingRule SamplingRule
created_at str

When the rule was created, in Unix time seconds.

modified_at str

When the rule was modified, in Unix time seconds.

sampling_rule SamplingRule
createdAt String

When the rule was created, in Unix time seconds.

modifiedAt String

When the rule was modified, in Unix time seconds.

samplingRule Property Map

SamplingRuleUpdate

Attributes object

Matches attributes derived from the request.

FixedRate double

The percentage of matching requests to instrument, after the reservoir is exhausted.

HTTPMethod string

Matches the HTTP method from a request URL.

Host string

Matches the hostname from a request URL.

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.

RuleARN string
RuleName string
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.

URLPath string

Matches the path from a request URL.

Attributes interface{}

Matches attributes derived from the request.

FixedRate float64

The percentage of matching requests to instrument, after the reservoir is exhausted.

HTTPMethod string

Matches the HTTP method from a request URL.

Host string

Matches the hostname from a request URL.

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.

RuleARN string
RuleName string
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.

URLPath string

Matches the path from a request URL.

attributes Object

Matches attributes derived from the request.

fixedRate Double

The percentage of matching requests to instrument, after the reservoir is exhausted.

hTTPMethod String

Matches the HTTP method from a request URL.

host String

Matches the hostname from a request URL.

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.

ruleARN String
ruleName String
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.

uRLPath String

Matches the path from a request URL.

attributes any

Matches attributes derived from the request.

fixedRate number

The percentage of matching requests to instrument, after the reservoir is exhausted.

hTTPMethod string

Matches the HTTP method from a request URL.

host string

Matches the hostname from a request URL.

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.

ruleARN string
ruleName string
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.

uRLPath string

Matches the path from a request URL.

attributes Any

Matches attributes derived from the request.

fixed_rate float

The percentage of matching requests to instrument, after the reservoir is exhausted.

h_ttp_method str

Matches the HTTP method from a request URL.

host str

Matches the hostname from a request URL.

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_arn str
rule_name str
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.

u_rl_path str

Matches the path from a request URL.

attributes Any

Matches attributes derived from the request.

fixedRate Number

The percentage of matching requests to instrument, after the reservoir is exhausted.

hTTPMethod String

Matches the HTTP method from a request URL.

host String

Matches the hostname from a request URL.

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.

ruleARN String
ruleName String
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.

uRLPath String

Matches the path from a request URL.

TagsItemProperties

Key string
Value string
Key string
Value string
key String
value String
key string
value string
key str
value str
key String
value String

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0