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

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.xray.SamplingRule

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    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:

    RuleName string
    SamplingRule SamplingRuleTypeArgs
    The sampling rule to be created or updated.
    SamplingRuleRecord SamplingRuleRecordArgs
    SamplingRuleUpdate SamplingRuleUpdateArgs
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    ruleName String
    samplingRule SamplingRule
    The sampling rule to be created or updated.
    samplingRuleRecord SamplingRuleRecord
    samplingRuleUpdate SamplingRuleUpdate
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    ruleName string
    samplingRule SamplingRule
    The sampling rule to be created or updated.
    samplingRuleRecord SamplingRuleRecord
    samplingRuleUpdate SamplingRuleUpdate
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    rule_name str
    sampling_rule SamplingRuleArgs
    The sampling rule to be created or updated.
    sampling_rule_record SamplingRuleRecordArgs
    sampling_rule_update SamplingRuleUpdateArgs
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    ruleName String
    samplingRule Property Map
    The sampling rule to be created or updated.
    samplingRuleRecord Property Map
    samplingRuleUpdate Property Map
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SamplingRule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleArn string
    The sampling rule ARN that was created or updated.
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleArn string
    The sampling rule ARN that was created or updated.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleArn String
    The sampling rule ARN that was created or updated.
    id string
    The provider-assigned unique ID for this managed resource.
    ruleArn string
    The sampling rule ARN that was created or updated.
    id str
    The provider-assigned unique ID for this managed resource.
    rule_arn str
    The sampling rule ARN that was created or updated.
    id String
    The provider-assigned unique ID for this managed resource.
    ruleArn String
    The sampling rule ARN that was created or updated.

    Supporting Types

    SamplingRule, SamplingRuleArgs

    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

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

    Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.

    RuleName string
    The name of the sampling rule. Specify a rule by either name or ARN, but not both.
    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

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

    Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.

    RuleName string
    The name of the sampling rule. Specify a rule by either name or ARN, but not both.
    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

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

    Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.

    ruleName String
    The name 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)
    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

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

    Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.

    ruleName string
    The name of the sampling rule. Specify a rule by either name or ARN, but not both.
    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

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

    Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.

    rule_name str
    The name of the sampling rule. Specify a rule by either name or ARN, but not both.
    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

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

    Specifying a sampling rule by name is recommended, as specifying by ARN will be deprecated in future.

    ruleName String
    The name of the sampling rule. Specify a rule by either name or ARN, but not both.
    version Number
    The version of the sampling rule format (1)

    SamplingRuleRecord, SamplingRuleRecordArgs

    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, SamplingRuleUpdateArgs

    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, TagArgs

    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.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native