Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-xray-samplingrule.json
Parent schema serverless-framework-configuration
Type: object

This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

SamplingRule object
13 nested properties
FixedRate number required

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

min=0max=1
Host string | Aws_CF_FunctionString required

Matches the hostname from a request URL.

HTTPMethod string | Aws_CF_FunctionString required

Matches the HTTP method from a request URL.

Priority integer required

The priority of the sampling rule.

min=1max=9999
ReservoirSize integer required

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.

min=0
ResourceARN string | Aws_CF_FunctionString required

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

ServiceName string | Aws_CF_FunctionString required

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

ServiceType string | Aws_CF_FunctionString required

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

URLPath string | Aws_CF_FunctionString required

Matches the path from a request URL.

Attributes object

Matches attributes derived from the request.

RuleARN string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

RuleName string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Version integer

The version of the sampling rule format (1)

min=1
SamplingRuleRecord object
3 nested properties
CreatedAt string | Aws_CF_FunctionString

When the rule was created, in Unix time seconds.

ModifiedAt string | Aws_CF_FunctionString

When the rule was modified, in Unix time seconds.

SamplingRule object
13 nested properties
FixedRate number required

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

min=0max=1
Host string | Aws_CF_FunctionString required

Matches the hostname from a request URL.

HTTPMethod string | Aws_CF_FunctionString required

Matches the HTTP method from a request URL.

Priority integer required

The priority of the sampling rule.

min=1max=9999
ReservoirSize integer required

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.

min=0
ResourceARN string | Aws_CF_FunctionString required

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

ServiceName string | Aws_CF_FunctionString required

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

ServiceType string | Aws_CF_FunctionString required

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

URLPath string | Aws_CF_FunctionString required

Matches the path from a request URL.

Attributes object

Matches attributes derived from the request.

RuleARN string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

RuleName string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Version integer

The version of the sampling rule format (1)

min=1
SamplingRuleUpdate object
12 nested properties
Attributes object

Matches attributes derived from the request.

FixedRate number

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

min=0max=1
Host string | Aws_CF_FunctionString

Matches the hostname from a request URL.

HTTPMethod string | Aws_CF_FunctionString

Matches the HTTP method from a request URL.

Priority integer

The priority of the sampling rule.

min=1max=9999
ReservoirSize integer

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.

min=0
ResourceARN string | Aws_CF_FunctionString

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

RuleARN string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

RuleName string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

ServiceName string | Aws_CF_FunctionString

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

ServiceType string | Aws_CF_FunctionString

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

URLPath string | Aws_CF_FunctionString

Matches the path from a request URL.

RuleName string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Tags Tag[]

An array of key-value pairs to apply to this resource.

Definitions

SamplingRule object
FixedRate number required

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

min=0max=1
Host string | Aws_CF_FunctionString required

Matches the hostname from a request URL.

HTTPMethod string | Aws_CF_FunctionString required

Matches the HTTP method from a request URL.

Priority integer required

The priority of the sampling rule.

min=1max=9999
ReservoirSize integer required

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.

min=0
ResourceARN string | Aws_CF_FunctionString required

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

ServiceName string | Aws_CF_FunctionString required

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

ServiceType string | Aws_CF_FunctionString required

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

URLPath string | Aws_CF_FunctionString required

Matches the path from a request URL.

Attributes object

Matches attributes derived from the request.

RuleARN string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

RuleName string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Version integer

The version of the sampling rule format (1)

min=1
SamplingRuleRecord object
CreatedAt string | Aws_CF_FunctionString

When the rule was created, in Unix time seconds.

ModifiedAt string | Aws_CF_FunctionString

When the rule was modified, in Unix time seconds.

SamplingRule object
13 nested properties
FixedRate number required

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

min=0max=1
Host string | Aws_CF_FunctionString required

Matches the hostname from a request URL.

HTTPMethod string | Aws_CF_FunctionString required

Matches the HTTP method from a request URL.

Priority integer required

The priority of the sampling rule.

min=1max=9999
ReservoirSize integer required

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.

min=0
ResourceARN string | Aws_CF_FunctionString required

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

ServiceName string | Aws_CF_FunctionString required

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

ServiceType string | Aws_CF_FunctionString required

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

URLPath string | Aws_CF_FunctionString required

Matches the path from a request URL.

Attributes object

Matches attributes derived from the request.

RuleARN string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

RuleName string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Version integer

The version of the sampling rule format (1)

min=1
SamplingRuleUpdate object
Attributes object

Matches attributes derived from the request.

FixedRate number

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

min=0max=1
Host string | Aws_CF_FunctionString

Matches the hostname from a request URL.

HTTPMethod string | Aws_CF_FunctionString

Matches the HTTP method from a request URL.

Priority integer

The priority of the sampling rule.

min=1max=9999
ReservoirSize integer

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.

min=0
ResourceARN string | Aws_CF_FunctionString

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

RuleARN string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

RuleName string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

ServiceName string | Aws_CF_FunctionString

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

ServiceType string | Aws_CF_FunctionString

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

URLPath string | Aws_CF_FunctionString

Matches the path from a request URL.

RuleName string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

RuleARN string | Aws_CF_FunctionString

The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

Tag object
Key string | Aws_CF_FunctionString required

The key name of the tag.

Value string | Aws_CF_FunctionString required

The value for the tag.

Tags Tag[]

An array of key-value pairs to apply to this resource.