You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::XRay::Types::CreateSamplingRuleRequest

Inherits:

Struct

Object
Struct
Aws::XRay::Types::CreateSamplingRuleRequest

show all

Defined in:: (unknown)

Overview

Note:

When passing CreateSamplingRuleRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  sampling_rule: { # required
    rule_name: "RuleName",
    rule_arn: "String",
    resource_arn: "ResourceARN", # required
    priority: 1, # required
    fixed_rate: 1.0, # required
    reservoir_size: 1, # required
    service_name: "ServiceName", # required
    service_type: "ServiceType", # required
    host: "Host", # required
    http_method: "HTTPMethod", # required
    url_path: "URLPath", # required
    version: 1, # required
    attributes: {
      "AttributeKey" => "AttributeValue",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

#sampling_rule ⇒ Types::SamplingRule
The rule definition.
#tags ⇒ Array<Types::Tag>
A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule.

Instance Attribute Details

#sampling_rule ⇒ `Types::SamplingRule`

The rule definition.

Returns:

(Types::SamplingRule) —
The rule definition.

#tags ⇒ `Array<Types::Tag>`

A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging AWS resources in the AWS General Reference.

The following restrictions apply to tags:

Maximum number of user-applied tags per resource: 50
Maximum tag key length: 128 Unicode characters
Maximum tag value length: 256 Unicode characters
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
Tag keys and values are case sensitive.
Don\'t use aws: as a prefix for keys; it\'s reserved for AWS use.