pulumi-aws-kotlin/com.pulumi.aws.xray.kotlin/SamplingRuleArgs

SamplingRuleArgs

data class SamplingRuleArgs(val attributes: Output<Map<String, String>>? = null, val fixedRate: Output<Double>? = null, val host: Output<String>? = null, val httpMethod: Output<String>? = null, val priority: Output<Int>? = null, val reservoirSize: Output<Int>? = null, val resourceArn: Output<String>? = null, val ruleName: Output<String>? = null, val serviceName: Output<String>? = null, val serviceType: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val urlPath: Output<String>? = null, val version: Output<Int>? = null) : ConvertibleToJava<SamplingRuleArgs>

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",
    },
});

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",
    })

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" },
        },
    });
});

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
	})
}

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());
    }
}

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

Import

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

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

Constructors

SamplingRuleArgs

fun SamplingRuleArgs(attributes: Output<Map<String, String>>? = null, fixedRate: Output<Double>? = null, host: Output<String>? = null, httpMethod: Output<String>? = null, priority: Output<Int>? = null, reservoirSize: Output<Int>? = null, resourceArn: Output<String>? = null, ruleName: Output<String>? = null, serviceName: Output<String>? = null, serviceType: Output<String>? = null, tags: Output<Map<String, String>>? = null, urlPath: Output<String>? = null, version: Output<Int>? = null)

Functions

toJava

open override fun toJava(): SamplingRuleArgs

Properties

attributes

val attributes: Output<Map<String, String>>? = null

Matches attributes derived from the request.

fixedRate

val fixedRate: Output<Double>? = null

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

host

val host: Output<String>? = null

Matches the hostname from a request URL.

httpMethod

val httpMethod: Output<String>? = null

Matches the HTTP method of a request.

priority

val priority: Output<Int>? = null

The priority of the sampling rule.

reservoirSize

val reservoirSize: Output<Int>? = null

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

val resourceArn: Output<String>? = null

Matches the ARN of the AWS resource on which the service runs.

ruleName

val ruleName: Output<String>? = null

The name of the sampling rule.

serviceName

val serviceName: Output<String>? = null

Matches the name that the service uses to identify itself in segments.

serviceType

val serviceType: Output<String>? = null

Matches the origin that the service uses to identify its type in segments.