class Aws::XRay::Types::SamplingRuleUpdate

A document specifying changes to a sampling rule's configuration.

@note When making an API call, you may pass SamplingRuleUpdate

data as a hash:

    {
      rule_name: "RuleName",
      rule_arn: "String",
      resource_arn: "ResourceARN",
      priority: 1,
      fixed_rate: 1.0,
      reservoir_size: 1,
      host: "Host",
      service_name: "ServiceName",
      service_type: "ServiceType",
      http_method: "HTTPMethod",
      url_path: "URLPath",
      attributes: {
        "AttributeKey" => "AttributeValue",
      },
    }

@!attribute [rw] rule_name

The name of the sampling rule. Specify a rule by either name or ARN,
but not both.
@return [String]

@!attribute [rw] rule_arn

The ARN of the sampling rule. Specify a rule by either name or ARN,
but not both.
@return [String]

@!attribute [rw] resource_arn

Matches the ARN of the Amazon Web Services resource on which the
service runs.
@return [String]

@!attribute [rw] priority

The priority of the sampling rule.
@return [Integer]

@!attribute [rw] fixed_rate

The percentage of matching requests to instrument, after the
reservoir is exhausted.
@return [Float]

@!attribute [rw] reservoir_size

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.
@return [Integer]

@!attribute [rw] host

Matches the hostname from a request URL.
@return [String]

@!attribute [rw] service_name

Matches the `name` that the service uses to identify itself in
segments.
@return [String]

@!attribute [rw] service_type

Matches the `origin` that the service uses to identify its type in
segments.
@return [String]

@!attribute [rw] http_method

Matches the HTTP method of a request.
@return [String]

@!attribute [rw] url_path

Matches the path from a request URL.
@return [String]

@!attribute [rw] attributes

Matches attributes derived from the request.
@return [Hash<String,String>]

@see docs.aws.amazon.com/goto/WebAPI/xray-2016-04-12/SamplingRuleUpdate AWS API Documentation

Constants

SENSITIVE