AWS Native is in preview. AWS Classic is fully supported.
aws-native.xray.SamplingRule
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Create SamplingRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SamplingRule(name: string, args?: SamplingRuleArgs, opts?: CustomResourceOptions);
@overload
def SamplingRule(resource_name: str,
args: Optional[SamplingRuleInitArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def SamplingRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
rule_name: Optional[str] = None,
sampling_rule: Optional[SamplingRuleArgs] = None,
sampling_rule_record: Optional[SamplingRuleRecordArgs] = None,
sampling_rule_update: Optional[SamplingRuleUpdateArgs] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewSamplingRule(ctx *Context, name string, args *SamplingRuleArgs, opts ...ResourceOption) (*SamplingRule, error)
public SamplingRule(string name, SamplingRuleArgs? args = null, CustomResourceOptions? opts = null)
public SamplingRule(String name, SamplingRuleArgs args)
public SamplingRule(String name, SamplingRuleArgs args, CustomResourceOptions options)
type: aws-native:xray:SamplingRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SamplingRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SamplingRuleInitArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SamplingRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SamplingRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SamplingRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const samplingRuleResource = new aws_native.xray.SamplingRule("samplingRuleResource", {
ruleName: "string",
samplingRule: {
resourceArn: "string",
fixedRate: 0,
host: "string",
httpMethod: "string",
priority: 0,
reservoirSize: 0,
serviceName: "string",
serviceType: "string",
urlPath: "string",
attributes: {
string: "string",
},
ruleArn: "string",
ruleName: "string",
version: 0,
},
samplingRuleRecord: {
createdAt: "string",
modifiedAt: "string",
samplingRule: {
resourceArn: "string",
fixedRate: 0,
host: "string",
httpMethod: "string",
priority: 0,
reservoirSize: 0,
serviceName: "string",
serviceType: "string",
urlPath: "string",
attributes: {
string: "string",
},
ruleArn: "string",
ruleName: "string",
version: 0,
},
},
samplingRuleUpdate: {
attributes: {
string: "string",
},
fixedRate: 0,
host: "string",
httpMethod: "string",
priority: 0,
reservoirSize: 0,
resourceArn: "string",
ruleArn: "string",
ruleName: "string",
serviceName: "string",
serviceType: "string",
urlPath: "string",
},
tags: [{
key: "string",
value: "string",
}],
});
Coming soon!
SamplingRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The SamplingRule resource accepts the following input properties:
Outputs
All input properties are implicitly available as output properties. Additionally, the SamplingRule resource produces the following output properties:
Supporting Types
SamplingRule, SamplingRuleArgs
- Fixed
Rate double - The percentage of matching requests to instrument, after the reservoir is exhausted.
- Host string
- Matches the hostname from a request URL.
- Http
Method string - Matches the HTTP method from a request URL.
- Priority int
- The priority of the sampling rule.
- Reservoir
Size int - 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 string - Matches the ARN of the AWS resource on which the service runs.
- Service
Name string - Matches the name that the service uses to identify itself in segments.
- Service
Type string - Matches the origin that the service uses to identify its type in segments.
- Url
Path string - Matches the path from a request URL.
- Attributes Dictionary<string, string>
- Matches attributes derived from the request.
- Rule
Arn string - Rule
Name string - Version int
- The version of the sampling rule format (1)
- Fixed
Rate float64 - The percentage of matching requests to instrument, after the reservoir is exhausted.
- Host string
- Matches the hostname from a request URL.
- Http
Method string - Matches the HTTP method from a request URL.
- Priority int
- The priority of the sampling rule.
- Reservoir
Size int - 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 string - Matches the ARN of the AWS resource on which the service runs.
- Service
Name string - Matches the name that the service uses to identify itself in segments.
- Service
Type string - Matches the origin that the service uses to identify its type in segments.
- Url
Path string - Matches the path from a request URL.
- Attributes map[string]string
- Matches attributes derived from the request.
- Rule
Arn string - Rule
Name string - Version int
- The version of the sampling rule format (1)
- fixed
Rate Double - The percentage of matching requests to instrument, after the reservoir is exhausted.
- host String
- Matches the hostname from a request URL.
- http
Method String - Matches the HTTP method from a request URL.
- priority Integer
- The priority of the sampling rule.
- reservoir
Size 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.
- resource
Arn String - Matches the ARN of the AWS resource on which the service runs.
- service
Name String - Matches the name that the service uses to identify itself in segments.
- service
Type String - Matches the origin that the service uses to identify its type in segments.
- url
Path String - Matches the path from a request URL.
- attributes Map<String,String>
- Matches attributes derived from the request.
- rule
Arn String - rule
Name String - version Integer
- The version of the sampling rule format (1)
- fixed
Rate number - The percentage of matching requests to instrument, after the reservoir is exhausted.
- host string
- Matches the hostname from a request URL.
- http
Method string - Matches the HTTP method from a request URL.
- priority number
- The priority of the sampling rule.
- reservoir
Size number - 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 string - Matches the ARN of the AWS resource on which the service runs.
- service
Name string - Matches the name that the service uses to identify itself in segments.
- service
Type string - Matches the origin that the service uses to identify its type in segments.
- url
Path string - Matches the path from a request URL.
- attributes {[key: string]: string}
- Matches attributes derived from the request.
- rule
Arn string - rule
Name string - version number
- The version of the sampling rule format (1)
- fixed_
rate float - The percentage of matching requests to instrument, after the reservoir is exhausted.
- host str
- Matches the hostname from a request URL.
- http_
method str - Matches the HTTP method from a request URL.
- priority int
- The priority of the sampling rule.
- reservoir_
size int - 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 str - Matches the ARN of the AWS resource on which the service runs.
- service_
name str - Matches the name that the service uses to identify itself in segments.
- service_
type str - Matches the origin that the service uses to identify its type in segments.
- url_
path str - Matches the path from a request URL.
- attributes Mapping[str, str]
- Matches attributes derived from the request.
- rule_
arn str - rule_
name str - version int
- The version of the sampling rule format (1)
- fixed
Rate Number - The percentage of matching requests to instrument, after the reservoir is exhausted.
- host String
- Matches the hostname from a request URL.
- http
Method String - Matches the HTTP method from a request URL.
- priority Number
- The priority of the sampling rule.
- reservoir
Size Number - 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 String - Matches the ARN of the AWS resource on which the service runs.
- service
Name String - Matches the name that the service uses to identify itself in segments.
- service
Type String - Matches the origin that the service uses to identify its type in segments.
- url
Path String - Matches the path from a request URL.
- attributes Map<String>
- Matches attributes derived from the request.
- rule
Arn String - rule
Name String - version Number
- The version of the sampling rule format (1)
SamplingRuleRecord, SamplingRuleRecordArgs
- Created
At string - When the rule was created, in Unix time seconds.
- Modified
At string - When the rule was modified, in Unix time seconds.
- Sampling
Rule Pulumi.Aws Native. XRay. Inputs. Sampling Rule
- Created
At string - When the rule was created, in Unix time seconds.
- Modified
At string - When the rule was modified, in Unix time seconds.
- Sampling
Rule SamplingRule Type
- created
At String - When the rule was created, in Unix time seconds.
- modified
At String - When the rule was modified, in Unix time seconds.
- sampling
Rule SamplingRule
- created
At string - When the rule was created, in Unix time seconds.
- modified
At string - When the rule was modified, in Unix time seconds.
- sampling
Rule SamplingRule
- created_
at str - When the rule was created, in Unix time seconds.
- modified_
at str - When the rule was modified, in Unix time seconds.
- sampling_
rule SamplingRule
- created
At String - When the rule was created, in Unix time seconds.
- modified
At String - When the rule was modified, in Unix time seconds.
- sampling
Rule Property Map
SamplingRuleUpdate, SamplingRuleUpdateArgs
- Attributes Dictionary<string, string>
- Matches attributes derived from the request.
- Fixed
Rate double - The percentage of matching requests to instrument, after the reservoir is exhausted.
- Host string
- Matches the hostname from a request URL.
- Http
Method string - Matches the HTTP method from a request URL.
- Priority int
- The priority of the sampling rule.
- Reservoir
Size int - 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 string - Matches the ARN of the AWS resource on which the service runs.
- Rule
Arn string - Rule
Name string - Service
Name string - Matches the name that the service uses to identify itself in segments.
- Service
Type string - Matches the origin that the service uses to identify its type in segments.
- Url
Path string - Matches the path from a request URL.
- Attributes map[string]string
- Matches attributes derived from the request.
- Fixed
Rate float64 - The percentage of matching requests to instrument, after the reservoir is exhausted.
- Host string
- Matches the hostname from a request URL.
- Http
Method string - Matches the HTTP method from a request URL.
- Priority int
- The priority of the sampling rule.
- Reservoir
Size int - 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 string - Matches the ARN of the AWS resource on which the service runs.
- Rule
Arn string - Rule
Name string - Service
Name string - Matches the name that the service uses to identify itself in segments.
- Service
Type string - Matches the origin that the service uses to identify its type in segments.
- Url
Path string - Matches the path from a request URL.
- attributes Map<String,String>
- Matches attributes derived from the request.
- fixed
Rate Double - The percentage of matching requests to instrument, after the reservoir is exhausted.
- host String
- Matches the hostname from a request URL.
- http
Method String - Matches the HTTP method from a request URL.
- priority Integer
- The priority of the sampling rule.
- reservoir
Size 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.
- resource
Arn String - Matches the ARN of the AWS resource on which the service runs.
- rule
Arn String - rule
Name String - service
Name String - Matches the name that the service uses to identify itself in segments.
- service
Type String - Matches the origin that the service uses to identify its type in segments.
- url
Path String - Matches the path from a request URL.
- attributes {[key: string]: string}
- Matches attributes derived from the request.
- fixed
Rate number - The percentage of matching requests to instrument, after the reservoir is exhausted.
- host string
- Matches the hostname from a request URL.
- http
Method string - Matches the HTTP method from a request URL.
- priority number
- The priority of the sampling rule.
- reservoir
Size number - 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 string - Matches the ARN of the AWS resource on which the service runs.
- rule
Arn string - rule
Name string - service
Name string - Matches the name that the service uses to identify itself in segments.
- service
Type string - Matches the origin that the service uses to identify its type in segments.
- url
Path string - Matches the path from a request URL.
- attributes Mapping[str, str]
- Matches attributes derived from the request.
- fixed_
rate float - The percentage of matching requests to instrument, after the reservoir is exhausted.
- host str
- Matches the hostname from a request URL.
- http_
method str - Matches the HTTP method from a request URL.
- priority int
- The priority of the sampling rule.
- reservoir_
size int - 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 str - Matches the ARN of the AWS resource on which the service runs.
- rule_
arn str - rule_
name str - service_
name str - Matches the name that the service uses to identify itself in segments.
- service_
type str - Matches the origin that the service uses to identify its type in segments.
- url_
path str - Matches the path from a request URL.
- attributes Map<String>
- Matches attributes derived from the request.
- fixed
Rate Number - The percentage of matching requests to instrument, after the reservoir is exhausted.
- host String
- Matches the hostname from a request URL.
- http
Method String - Matches the HTTP method from a request URL.
- priority Number
- The priority of the sampling rule.
- reservoir
Size Number - 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 String - Matches the ARN of the AWS resource on which the service runs.
- rule
Arn String - rule
Name String - service
Name String - Matches the name that the service uses to identify itself in segments.
- service
Type String - Matches the origin that the service uses to identify its type in segments.
- url
Path String - Matches the path from a request URL.
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.