1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. xray

Module xray

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource SamplingRule

class SamplingRule extends CustomResource

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", {
    attributes: {
        Hello: "Tris",
    },
    fixedRate: 0.05,
    host: "*",
    httpMethod: "*",
    priority: 10000,
    reservoirSize: 1,
    resourceArn: "*",
    ruleName: "example",
    serviceName: "*",
    serviceType: "*",
    urlPath: "*",
    version: 1,
});

constructor

new SamplingRule(name: string, args: SamplingRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a SamplingRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SamplingRuleState, opts?: pulumi.CustomResourceOptions): SamplingRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SamplingRule

Returns true if the given object is an instance of SamplingRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the sampling rule.

property attributes

public attributes: pulumi.Output<{[key: string]: string} | undefined>;

Matches attributes derived from the request.

property fixedRate

public fixedRate: pulumi.Output<number>;

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

property host

public host: pulumi.Output<string>;

Matches the hostname from a request URL.

property httpMethod

public httpMethod: pulumi.Output<string>;

Matches the HTTP method of a request.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property priority

public priority: pulumi.Output<number>;

The priority of the sampling rule.

property reservoirSize

public reservoirSize: pulumi.Output<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.

property resourceArn

public resourceArn: pulumi.Output<string>;

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

property ruleName

public ruleName: pulumi.Output<string | undefined>;

The name of the sampling rule.

property serviceName

public serviceName: pulumi.Output<string>;

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

property serviceType

public serviceType: pulumi.Output<string>;

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

property urlPath

public urlPath: pulumi.Output<string>;

Matches the path from a request URL.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<number>;

The version of the sampling rule format (1 )

Others

interface SamplingRuleArgs

interface SamplingRuleArgs

The set of arguments for constructing a SamplingRule resource.

property attributes

attributes?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Matches attributes derived from the request.

property fixedRate

fixedRate: pulumi.Input<number>;

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

property host

host: pulumi.Input<string>;

Matches the hostname from a request URL.

property httpMethod

httpMethod: pulumi.Input<string>;

Matches the HTTP method of a request.

property priority

priority: pulumi.Input<number>;

The priority of the sampling rule.

property reservoirSize

reservoirSize: pulumi.Input<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.

property resourceArn

resourceArn: pulumi.Input<string>;

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

property ruleName

ruleName?: pulumi.Input<string>;

The name of the sampling rule.

property serviceName

serviceName: pulumi.Input<string>;

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

property serviceType

serviceType: pulumi.Input<string>;

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

property urlPath

urlPath: pulumi.Input<string>;

Matches the path from a request URL.

property version

version: pulumi.Input<number>;

The version of the sampling rule format (1 )

interface SamplingRuleState

interface SamplingRuleState

Input properties used for looking up and filtering SamplingRule resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the sampling rule.

property attributes

attributes?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Matches attributes derived from the request.

property fixedRate

fixedRate?: pulumi.Input<number>;

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

property host

host?: pulumi.Input<string>;

Matches the hostname from a request URL.

property httpMethod

httpMethod?: pulumi.Input<string>;

Matches the HTTP method of a request.

property priority

priority?: pulumi.Input<number>;

The priority of the sampling rule.

property reservoirSize

reservoirSize?: pulumi.Input<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.

property resourceArn

resourceArn?: pulumi.Input<string>;

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

property ruleName

ruleName?: pulumi.Input<string>;

The name of the sampling rule.

property serviceName

serviceName?: pulumi.Input<string>;

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

property serviceType

serviceType?: pulumi.Input<string>;

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

property urlPath

urlPath?: pulumi.Input<string>;

Matches the path from a request URL.

property version

version?: pulumi.Input<number>;

The version of the sampling rule format (1 )