xray

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.

class pulumi_aws.xray.SamplingRule(resource_name, opts=None, attributes=None, fixed_rate=None, host=None, http_method=None, priority=None, reservoir_size=None, resource_arn=None, rule_name=None, service_name=None, service_type=None, url_path=None, version=None, __props__=None, __name__=None, __opts__=None)

Creates and manages an AWS XRay Sampling Rule.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • attributes (pulumi.Input[dict]) – Matches attributes derived from the request.

  • fixed_rate (pulumi.Input[float]) – The percentage of matching requests to instrument, after the reservoir is exhausted.

  • host (pulumi.Input[str]) – Matches the hostname from a request URL.

  • http_method (pulumi.Input[str]) – Matches the HTTP method of a request.

  • priority (pulumi.Input[float]) – The priority of the sampling rule.

  • reservoir_size (pulumi.Input[float]) – 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 (pulumi.Input[str]) – Matches the ARN of the AWS resource on which the service runs.

  • rule_name (pulumi.Input[str]) – The name of the sampling rule.

  • service_name (pulumi.Input[str]) – Matches the name that the service uses to identify itself in segments.

  • service_type (pulumi.Input[str]) – Matches the origin that the service uses to identify its type in segments.

  • url_path (pulumi.Input[str]) – Matches the path from a request URL.

  • version (pulumi.Input[float]) – The version of the sampling rule format (1 )

arn = None

The ARN of the sampling rule.

attributes = None

Matches attributes derived from the request.

fixed_rate = None

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

host = None

Matches the hostname from a request URL.

http_method = None

Matches the HTTP method of a request.

priority = None

The priority of the sampling rule.

reservoir_size = None

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 = None

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

rule_name = None

The name of the sampling rule.

service_name = None

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

service_type = None

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

url_path = None

Matches the path from a request URL.

version = None

The version of the sampling rule format (1 )

static get(resource_name, id, opts=None, arn=None, attributes=None, fixed_rate=None, host=None, http_method=None, priority=None, reservoir_size=None, resource_arn=None, rule_name=None, service_name=None, service_type=None, url_path=None, version=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • arn (pulumi.Input[str]) – The ARN of the sampling rule.

  • attributes (pulumi.Input[dict]) – Matches attributes derived from the request.

  • fixed_rate (pulumi.Input[float]) – The percentage of matching requests to instrument, after the reservoir is exhausted.

  • host (pulumi.Input[str]) – Matches the hostname from a request URL.

  • http_method (pulumi.Input[str]) – Matches the HTTP method of a request.

  • priority (pulumi.Input[float]) – The priority of the sampling rule.

  • reservoir_size (pulumi.Input[float]) – 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 (pulumi.Input[str]) – Matches the ARN of the AWS resource on which the service runs.

  • rule_name (pulumi.Input[str]) – The name of the sampling rule.

  • service_name (pulumi.Input[str]) – Matches the name that the service uses to identify itself in segments.

  • service_type (pulumi.Input[str]) – Matches the origin that the service uses to identify its type in segments.

  • url_path (pulumi.Input[str]) – Matches the path from a request URL.

  • version (pulumi.Input[float]) – The version of the sampling rule format (1 )

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str