aws_xray_sampling_rule

account_id

Type: STRING

created_at

Type: TIMESTAMP
Provider name: CreatedAt
Description: When the rule was created.

modified_at

Type: TIMESTAMP
Provider name: ModifiedAt
Description: When the rule was last modified.

sampling_rule

Type: STRUCT
Provider name: SamplingRule
Description: The sampling rule.

• attributes
  Type: MAP_STRING_STRING
  Provider name: Attributes
  Description: Matches attributes derived from the request.
  
• fixed_rate
  Type: DOUBLE
  Provider name: FixedRate
  Description: The percentage of matching requests to instrument, after the reservoir is exhausted.
  
• host
  Type: STRING
  Provider name: Host
  Description: Matches the hostname from a request URL.
  
• http_method
  Type: STRING
  Provider name: HTTPMethod
  Description: Matches the HTTP method of a request.
  
• priority
  Type: INT32
  Provider name: Priority
  Description: The priority of the sampling rule.
  
• reservoir_size
  Type: INT32
  Provider name: ReservoirSize
  Description: 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
  Type: STRING
  Provider name: ResourceARN
  Description: Matches the ARN of the Amazon Web Services resource on which the service runs.
  
• rule_arn
  Type: STRING
  Provider name: RuleARN
  Description: The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
  
• rule_name
  Type: STRING
  Provider name: RuleName
  Description: The name of the sampling rule. Specify a rule by either name or ARN, but not both.
  
• sampling_rate_boost
  Type: STRUCT
  Provider name: SamplingRateBoost
  Description: Specifies the multiplier applied to the base sampling rate. This boost allows you to temporarily increase sampling without changing the rule’s configuration.
  
  • cooldown_window_minutes
    Type: INT32
    Provider name: CooldownWindowMinutes
    Description: Sets the time window (in minutes) in which only one sampling rate boost can be triggered. After a boost occurs, no further boosts are allowed until the next window.
    
  • max_rate
    Type: DOUBLE
    Provider name: MaxRate
    Description: Defines max temporary sampling rate to apply when a boost is triggered. Calculated boost rate by X-Ray will be less than or equal to this max rate.
    
• service_name
  Type: STRING
  Provider name: ServiceName
  Description: Matches the name that the service uses to identify itself in segments.
  
• service_type
  Type: STRING
  Provider name: ServiceType
  Description: Matches the origin that the service uses to identify its type in segments.
  
• url_path
  Type: STRING
  Provider name: URLPath
  Description: Matches the path from a request URL.
  
• version
  Type: INT32
  Provider name: Version
  Description: The version of the sampling rule format (1).
  

tags

Type: UNORDERED_LIST_STRING