Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. xray
  5. getSamplingRule

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.xray.getSamplingRule

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    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:

    RuleArn string
    RuleArn string
    ruleArn String
    ruleArn string
    ruleArn String

    getSamplingRule Result

    The following output properties are available:

    Supporting Types

    SamplingRule

    FixedRate double
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    Host string
    Matches the hostname from a request URL.
    HttpMethod string
    Matches the HTTP method from a request URL.
    Priority int
    The priority of the sampling rule.
    ReservoirSize 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.
    ResourceArn string
    Matches the ARN of the AWS resource on which the service runs.
    ServiceName string
    Matches the name that the service uses to identify itself in segments.
    ServiceType string
    Matches the origin that the service uses to identify its type in segments.
    UrlPath string
    Matches the path from a request URL.
    Attributes Dictionary<string, string>
    Matches attributes derived from the request.
    RuleArn string
    RuleName string
    Version int
    The version of the sampling rule format (1)
    FixedRate float64
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    Host string
    Matches the hostname from a request URL.
    HttpMethod string
    Matches the HTTP method from a request URL.
    Priority int
    The priority of the sampling rule.
    ReservoirSize 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.
    ResourceArn string
    Matches the ARN of the AWS resource on which the service runs.
    ServiceName string
    Matches the name that the service uses to identify itself in segments.
    ServiceType string
    Matches the origin that the service uses to identify its type in segments.
    UrlPath string
    Matches the path from a request URL.
    Attributes map[string]string
    Matches attributes derived from the request.
    RuleArn string
    RuleName string
    Version int
    The version of the sampling rule format (1)
    fixedRate Double
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    host String
    Matches the hostname from a request URL.
    httpMethod String
    Matches the HTTP method from a request URL.
    priority Integer
    The priority of the sampling rule.
    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.
    resourceArn String
    Matches the ARN of the AWS resource on which the service runs.
    serviceName String
    Matches the name that the service uses to identify itself in segments.
    serviceType String
    Matches the origin that the service uses to identify its type in segments.
    urlPath String
    Matches the path from a request URL.
    attributes Map<String,String>
    Matches attributes derived from the request.
    ruleArn String
    ruleName String
    version Integer
    The version of the sampling rule format (1)
    fixedRate number
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    host string
    Matches the hostname from a request URL.
    httpMethod string
    Matches the HTTP method from a request URL.
    priority number
    The priority of the sampling rule.
    reservoirSize 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.
    resourceArn string
    Matches the ARN of the AWS resource on which the service runs.
    serviceName string
    Matches the name that the service uses to identify itself in segments.
    serviceType string
    Matches the origin that the service uses to identify its type in segments.
    urlPath string
    Matches the path from a request URL.
    attributes {[key: string]: string}
    Matches attributes derived from the request.
    ruleArn string
    ruleName 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)
    fixedRate Number
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    host String
    Matches the hostname from a request URL.
    httpMethod String
    Matches the HTTP method from a request URL.
    priority Number
    The priority of the sampling rule.
    reservoirSize 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.
    resourceArn String
    Matches the ARN of the AWS resource on which the service runs.
    serviceName String
    Matches the name that the service uses to identify itself in segments.
    serviceType String
    Matches the origin that the service uses to identify its type in segments.
    urlPath String
    Matches the path from a request URL.
    attributes Map<String>
    Matches attributes derived from the request.
    ruleArn String
    ruleName String
    version Number
    The version of the sampling rule format (1)

    SamplingRuleRecord

    CreatedAt string
    When the rule was created, in Unix time seconds.
    ModifiedAt string
    When the rule was modified, in Unix time seconds.
    SamplingRule Pulumi.AwsNative.XRay.Inputs.SamplingRule
    CreatedAt string
    When the rule was created, in Unix time seconds.
    ModifiedAt string
    When the rule was modified, in Unix time seconds.
    SamplingRule SamplingRuleType
    createdAt String
    When the rule was created, in Unix time seconds.
    modifiedAt String
    When the rule was modified, in Unix time seconds.
    samplingRule SamplingRule
    createdAt string
    When the rule was created, in Unix time seconds.
    modifiedAt string
    When the rule was modified, in Unix time seconds.
    samplingRule 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
    createdAt String
    When the rule was created, in Unix time seconds.
    modifiedAt String
    When the rule was modified, in Unix time seconds.
    samplingRule Property Map

    SamplingRuleUpdate

    Attributes Dictionary<string, string>
    Matches attributes derived from the request.
    FixedRate double
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    Host string
    Matches the hostname from a request URL.
    HttpMethod string
    Matches the HTTP method from a request URL.
    Priority int
    The priority of the sampling rule.
    ReservoirSize 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.
    ResourceArn string
    Matches the ARN of the AWS resource on which the service runs.
    RuleArn string
    RuleName string
    ServiceName string
    Matches the name that the service uses to identify itself in segments.
    ServiceType string
    Matches the origin that the service uses to identify its type in segments.
    UrlPath string
    Matches the path from a request URL.
    Attributes map[string]string
    Matches attributes derived from the request.
    FixedRate float64
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    Host string
    Matches the hostname from a request URL.
    HttpMethod string
    Matches the HTTP method from a request URL.
    Priority int
    The priority of the sampling rule.
    ReservoirSize 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.
    ResourceArn string
    Matches the ARN of the AWS resource on which the service runs.
    RuleArn string
    RuleName string
    ServiceName string
    Matches the name that the service uses to identify itself in segments.
    ServiceType string
    Matches the origin that the service uses to identify its type in segments.
    UrlPath string
    Matches the path from a request URL.
    attributes Map<String,String>
    Matches attributes derived from the request.
    fixedRate Double
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    host String
    Matches the hostname from a request URL.
    httpMethod String
    Matches the HTTP method from a request URL.
    priority Integer
    The priority of the sampling rule.
    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.
    resourceArn String
    Matches the ARN of the AWS resource on which the service runs.
    ruleArn String
    ruleName String
    serviceName String
    Matches the name that the service uses to identify itself in segments.
    serviceType String
    Matches the origin that the service uses to identify its type in segments.
    urlPath String
    Matches the path from a request URL.
    attributes {[key: string]: string}
    Matches attributes derived from the request.
    fixedRate number
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    host string
    Matches the hostname from a request URL.
    httpMethod string
    Matches the HTTP method from a request URL.
    priority number
    The priority of the sampling rule.
    reservoirSize 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.
    resourceArn string
    Matches the ARN of the AWS resource on which the service runs.
    ruleArn string
    ruleName string
    serviceName string
    Matches the name that the service uses to identify itself in segments.
    serviceType string
    Matches the origin that the service uses to identify its type in segments.
    urlPath 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.
    fixedRate Number
    The percentage of matching requests to instrument, after the reservoir is exhausted.
    host String
    Matches the hostname from a request URL.
    httpMethod String
    Matches the HTTP method from a request URL.
    priority Number
    The priority of the sampling rule.
    reservoirSize 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.
    resourceArn String
    Matches the ARN of the AWS resource on which the service runs.
    ruleArn String
    ruleName String
    serviceName String
    Matches the name that the service uses to identify itself in segments.
    serviceType String
    Matches the origin that the service uses to identify its type in segments.
    urlPath String
    Matches the path from a request URL.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native