aws-native.xray.getSamplingRule
This schema provides construct and validation rules for AWS-XRay SamplingRule resource parameters.
Using getSamplingRule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getSamplingRule(args: GetSamplingRuleArgs, opts?: InvokeOptions): Promise<GetSamplingRuleResult>
function getSamplingRuleOutput(args: GetSamplingRuleOutputArgs, opts?: InvokeOptions): Output<GetSamplingRuleResult>
def get_sampling_rule(rule_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetSamplingRuleResult
def get_sampling_rule_output(rule_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSamplingRuleResult]
func LookupSamplingRule(ctx *Context, args *LookupSamplingRuleArgs, opts ...InvokeOption) (*LookupSamplingRuleResult, error)
func LookupSamplingRuleOutput(ctx *Context, args *LookupSamplingRuleOutputArgs, opts ...InvokeOption) LookupSamplingRuleResultOutput
> Note: This function is named LookupSamplingRule
in the Go SDK.
public static class GetSamplingRule
{
public static Task<GetSamplingRuleResult> InvokeAsync(GetSamplingRuleArgs args, InvokeOptions? opts = null)
public static Output<GetSamplingRuleResult> Invoke(GetSamplingRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSamplingRuleResult> getSamplingRule(GetSamplingRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:xray:getSamplingRule
arguments:
# arguments dictionary
The following arguments are supported:
- Rule
ARN string
- Rule
ARN string
- rule
ARN String
- rule
ARN string
- rule_
arn str
- rule
ARN String
getSamplingRule Result
The following output properties are available:
Supporting Types
SamplingRule
- Attributes object
Matches attributes derived from the request.
- Fixed
Rate double The percentage of matching requests to instrument, after the reservoir is exhausted.
- HTTPMethod string
Matches the HTTP method from a request URL.
- Host string
Matches the hostname 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.
- URLPath string
Matches the path from a request URL.
- Version int
The version of the sampling rule format (1)
- Attributes interface{}
Matches attributes derived from the request.
- Fixed
Rate float64 The percentage of matching requests to instrument, after the reservoir is exhausted.
- HTTPMethod string
Matches the HTTP method from a request URL.
- Host string
Matches the hostname 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.
- URLPath string
Matches the path from a request URL.
- Version int
The version of the sampling rule format (1)
- attributes Object
Matches attributes derived from the request.
- fixed
Rate Double The percentage of matching requests to instrument, after the reservoir is exhausted.
- h
TTPMethod String Matches the HTTP method from a request URL.
- host String
Matches the hostname 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.
- u
RLPath String Matches the path from a request URL.
- version Integer
The version of the sampling rule format (1)
- attributes any
Matches attributes derived from the request.
- fixed
Rate number The percentage of matching requests to instrument, after the reservoir is exhausted.
- h
TTPMethod string Matches the HTTP method from a request URL.
- host string
Matches the hostname 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.
- u
RLPath string Matches the path from a request URL.
- version number
The version of the sampling rule format (1)
- attributes Any
Matches attributes derived from the request.
- fixed_
rate float The percentage of matching requests to instrument, after the reservoir is exhausted.
- h_
ttp_ strmethod Matches the HTTP method from a request URL.
- host str
Matches the hostname 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.
- u_
rl_ strpath Matches the path from a request URL.
- version int
The version of the sampling rule format (1)
- attributes Any
Matches attributes derived from the request.
- fixed
Rate Number The percentage of matching requests to instrument, after the reservoir is exhausted.
- h
TTPMethod String Matches the HTTP method from a request URL.
- host String
Matches the hostname 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.
- u
RLPath String Matches the path from a request URL.
- version Number
The version of the sampling rule format (1)
SamplingRuleRecord
- 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
- Attributes object
Matches attributes derived from the request.
- Fixed
Rate double The percentage of matching requests to instrument, after the reservoir is exhausted.
- HTTPMethod string
Matches the HTTP method from a request URL.
- Host string
Matches the hostname 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.
- URLPath string
Matches the path from a request URL.
- Attributes interface{}
Matches attributes derived from the request.
- Fixed
Rate float64 The percentage of matching requests to instrument, after the reservoir is exhausted.
- HTTPMethod string
Matches the HTTP method from a request URL.
- Host string
Matches the hostname 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.
- URLPath string
Matches the path from a request URL.
- attributes Object
Matches attributes derived from the request.
- fixed
Rate Double The percentage of matching requests to instrument, after the reservoir is exhausted.
- h
TTPMethod String Matches the HTTP method from a request URL.
- host String
Matches the hostname 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.
- u
RLPath String Matches the path from a request URL.
- attributes any
Matches attributes derived from the request.
- fixed
Rate number The percentage of matching requests to instrument, after the reservoir is exhausted.
- h
TTPMethod string Matches the HTTP method from a request URL.
- host string
Matches the hostname 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.
- u
RLPath string Matches the path from a request URL.
- attributes Any
Matches attributes derived from the request.
- fixed_
rate float The percentage of matching requests to instrument, after the reservoir is exhausted.
- h_
ttp_ strmethod Matches the HTTP method from a request URL.
- host str
Matches the hostname 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.
- u_
rl_ strpath Matches the path from a request URL.
- attributes Any
Matches attributes derived from the request.
- fixed
Rate Number The percentage of matching requests to instrument, after the reservoir is exhausted.
- h
TTPMethod String Matches the HTTP method from a request URL.
- host String
Matches the hostname 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.
- u
RLPath String Matches the path from a request URL.
TagsItemProperties
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0