IndexingRule class

Manages an AWS X-Ray indexing rule.

> Note: Removing this resource from Terraform has no effect on the indedxing rule within AWS X-Ray.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.xray.IndexingRule("example", {
    rule: {
        probabilistic: {
            desiredSamplingPercentage: 0.66,
        },
    },
    name: "Default",
});
import pulumi
import pulumi_aws as aws

example = aws.xray.IndexingRule("example",
    rule={
        "probabilistic": {
            "desired_sampling_percentage": 0.66,
        },
    },
    name="Default")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Xray.IndexingRule("example", new()
    {
        Rule = new Aws.Xray.Inputs.IndexingRuleRuleArgs
        {
            Probabilistic = new Aws.Xray.Inputs.IndexingRuleRuleProbabilisticArgs
            {
                DesiredSamplingPercentage = 0.66,
            },
        },
        Name = "Default",
    });

});
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.NewIndexingRule(ctx, "example", &xray.IndexingRuleArgs{
			Rule: &xray.IndexingRuleRuleArgs{
				Probabilistic: &xray.IndexingRuleRuleProbabilisticArgs{
					DesiredSamplingPercentage: pulumi.Float64(0.66),
				},
			},
			Name: pulumi.String("Default"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_xray_indexingrule" "example" {
  rule = {
    probabilistic = {
      desired_sampling_percentage = 0.66
    }
  }
  name = "Default"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.xray.IndexingRule;
import com.pulumi.aws.xray.IndexingRuleArgs;
import com.pulumi.aws.xray.inputs.IndexingRuleRuleArgs;
import com.pulumi.aws.xray.inputs.IndexingRuleRuleProbabilisticArgs;
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 IndexingRule("example", IndexingRuleArgs.builder()
            .rule(IndexingRuleRuleArgs.builder()
                .probabilistic(IndexingRuleRuleProbabilisticArgs.builder()
                    .desiredSamplingPercentage(0.66)
                    .build())
                .build())
            .name("Default")
            .build());

    }
}
resources:
  example:
    type: aws:xray:IndexingRule
    properties:
      rule:
        probabilistic:
          desiredSamplingPercentage: 0.66
      name: Default

Import

Identity Schema

Required

  • name (String) Indexing 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 Indexing Rules using name. For example:

$ pulumi import aws:xray/indexingRule:IndexingRule example Default

Constructors

IndexingRule(String name, {IndexingRuleArgs? args, CustomResourceOptions? options})
Creates a new IndexingRule. name The Pulumi resource name. args Arguments used to configure this IndexingRule. The set of arguments for IndexingRule. options Resource options controlling this resource's behavior.
IndexingRule.reference(String urn)
Creates a typed reference to an existing IndexingRule resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
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
name ↔ Output<String>
Indexing rule name.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
rule ↔ Output<IndexingRuleRule>
Rule configuration. See rule Block below.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

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, {IndexingRuleState? state, CustomResourceOptions? options}) → IndexingRule
Gets an existing IndexingRule resource's state with the given name and id.