SamplingRule class
Creates and manages an AWS XRay Sampling Rule.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.xray.SamplingRule("example", {
ruleName: "example",
priority: 9999,
version: 1,
reservoirSize: 1,
fixedRate: 0.05,
urlPath: "*",
host: "*",
httpMethod: "*",
serviceType: "*",
serviceName: "*",
resourceArn: "*",
attributes: {
Hello: "Tris",
},
});
import pulumi
import pulumi_aws as aws
example = aws.xray.SamplingRule("example",
rule_name="example",
priority=9999,
version=1,
reservoir_size=1,
fixed_rate=0.05,
url_path="*",
host="*",
http_method="*",
service_type="*",
service_name="*",
resource_arn="*",
attributes={
"Hello": "Tris",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Xray.SamplingRule("example", new()
{
RuleName = "example",
Priority = 9999,
Version = 1,
ReservoirSize = 1,
FixedRate = 0.05,
UrlPath = "*",
Host = "*",
HttpMethod = "*",
ServiceType = "*",
ServiceName = "*",
ResourceArn = "*",
Attributes =
{
{ "Hello", "Tris" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/xray"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := xray.NewSamplingRule(ctx, "example", &xray.SamplingRuleArgs{
RuleName: pulumi.String("example"),
Priority: pulumi.Int(9999),
Version: pulumi.Int(1),
ReservoirSize: pulumi.Int(1),
FixedRate: pulumi.Float64(0.05),
UrlPath: pulumi.String("*"),
Host: pulumi.String("*"),
HttpMethod: pulumi.String("*"),
ServiceType: pulumi.String("*"),
ServiceName: pulumi.String("*"),
ResourceArn: pulumi.String("*"),
Attributes: pulumi.StringMap{
"Hello": pulumi.String("Tris"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_xray_samplingrule" "example" {
rule_name = "example"
priority = 9999
version = 1
reservoir_size = 1
fixed_rate = 0.05
url_path = "*"
host = "*"
http_method = "*"
service_type = "*"
service_name = "*"
resource_arn = "*"
attributes = {
"Hello" = "Tris"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.xray.SamplingRule;
import com.pulumi.aws.xray.SamplingRuleArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new SamplingRule("example", SamplingRuleArgs.builder()
.ruleName("example")
.priority(9999)
.version(1)
.reservoirSize(1)
.fixedRate(0.05)
.urlPath("*")
.host("*")
.httpMethod("*")
.serviceType("*")
.serviceName("*")
.resourceArn("*")
.attributes(Map.of("Hello", "Tris"))
.build());
}
}
resources:
example:
type: aws:xray:SamplingRule
properties:
ruleName: example
priority: 9999
version: 1
reservoirSize: 1
fixedRate: 0.05
urlPath: '*'
host: '*'
httpMethod: '*'
serviceType: '*'
serviceName: '*'
resourceArn: '*'
attributes:
Hello: Tris
Import
Identity Schema
Required
ruleName(String) Sampling rule name.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import XRay Sampling Rules using ruleName. For example:
$ pulumi import aws:xray/samplingRule:SamplingRule example example-rule
Constructors
- SamplingRule(String name, {SamplingRuleArgs? args, CustomResourceOptions? options})
-
Creates a new SamplingRule.
nameThe Pulumi resource name.argsArguments used to configure this SamplingRule. The set of arguments for SamplingRule.optionsResource options controlling this resource's behavior. - SamplingRule.reference(String urn)
- Creates a typed reference to an existing SamplingRule resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the sampling rule.
latefinal
-
attributes
↔ Output<
Map< String, String> ?> -
Matches attributes derived from the request.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
fixedRate
↔ Output<
double> -
The percentage of matching requests to instrument, after the reservoir is exhausted.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
host
↔ Output<
String> -
Matches the hostname from a request URL.
latefinal
-
httpMethod
↔ Output<
String> -
Matches the HTTP method of a request.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
priority
↔ Output<
int> -
The priority of the sampling rule.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
reservoirSize
↔ Output<
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.
latefinal
-
resourceArn
↔ Output<
String> -
Matches the ARN of the AWS resource on which the service runs.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
ruleName
↔ Output<
String?> -
The name of the sampling rule.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serviceName
↔ Output<
String> -
Matches the
namethat the service uses to identify itself in segments.latefinal -
serviceType
↔ Output<
String> -
Matches the
originthat the service uses to identify its type in segments.latefinal -
Key-value mapping of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-levellatefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urlPath
↔ Output<
String> -
Matches the path from a request URL.
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
-
version
↔ Output<
int> -
The version of the sampling rule format (
1)latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {SamplingRuleState? state, CustomResourceOptions? options}) → SamplingRule -
Gets an existing SamplingRule resource's state with the given
nameandid.