← All packages

AWS Native

Pulumi Official

Package maintained by Pulumi

v0.16.1 published on Saturday, Apr 30, 2022 by Pulumi

Source code

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:

RuleARN string

RuleARN string

ruleARN String

ruleARN string

rule_arn str

ruleARN String

getSamplingRule Result

The following output properties are available:

RuleARN string
RuleName string
SamplingRuleRecord Pulumi.AwsNative.XRay.Outputs.SamplingRuleRecord
SamplingRuleUpdate Pulumi.AwsNative.XRay.Outputs.SamplingRuleUpdate
SamplingRuleValue Pulumi.AwsNative.XRay.Outputs.SamplingRule
Tags List<Pulumi.AwsNative.XRay.Outputs.TagsItemProperties>

RuleARN string
RuleName string
SamplingRule SamplingRuleType
SamplingRuleRecord SamplingRuleRecord
SamplingRuleUpdate SamplingRuleUpdate
Tags []TagsItemProperties

ruleARN String
ruleName String
samplingRule SamplingRule
samplingRuleRecord SamplingRuleRecord
samplingRuleUpdate SamplingRuleUpdate
tags ListItemProperties>

ruleARN string
ruleName string
samplingRule SamplingRule
samplingRuleRecord SamplingRuleRecord
samplingRuleUpdate SamplingRuleUpdate
tags TagsItemProperties[]

rule_arn str
rule_name str
sampling_rule SamplingRule
sampling_rule_record SamplingRuleRecord
sampling_rule_update SamplingRuleUpdate
tags Sequence[TagsItemProperties]

ruleARN String
ruleName String
samplingRule Property Map
samplingRuleRecord Property Map
samplingRuleUpdate Property Map
tags List

Supporting Types

SamplingRule

Attributes object: Matches attributes derived from the request.
FixedRate 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.
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.
Version int: The version of the sampling rule format (1)

Attributes interface{}: Matches attributes derived from the request.
FixedRate 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.
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.
Version int: The version of the sampling rule format (1)

attributes Object: Matches attributes derived from the request.
fixedRate 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 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.
version Integer: The version of the sampling rule format (1)

attributes any: Matches attributes derived from the request.
fixedRate number: 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 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.
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_method str: 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_path str: 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.
fixedRate Number: 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 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.
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 object: Matches attributes derived from the request.
FixedRate 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.
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 interface{}: Matches attributes derived from the request.
FixedRate 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.
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 Object: Matches attributes derived from the request.
fixedRate 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 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 any: Matches attributes derived from the request.
fixedRate number: 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 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 Any: Matches attributes derived from the request.
fixed_rate float: The percentage of matching requests to instrument, after the reservoir is exhausted.
h_ttp_method str: 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_path str: Matches the path from a request URL.

attributes Any: Matches attributes derived from the request.
fixedRate Number: 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 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.

TagsItemProperties

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

Package Details

Repository: https://github.com/pulumi/pulumi-aws-native
License: Apache-2.0