Package com.pulumi.aws.xray

Class IndexingRule

  • public class IndexingRule
extends com.pulumi.resources.CustomResource
    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 
     
 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());
 
     }
 }
    ## 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: ```sh $ pulumi import aws:xray/indexingRule:IndexingRule example Default ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static IndexingRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, IndexingRuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<IndexingRuleRule> rule()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • IndexingRule

        public IndexingRule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • IndexingRule

        public IndexingRule​(java.lang.String name,
                    IndexingRuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • IndexingRule

        public IndexingRule​(java.lang.String name,
                    IndexingRuleArgs args,
                    @Nullable
                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Indexing rule name.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • rule

        public com.pulumi.core.Output<IndexingRuleRule> rule()
        Returns:
        Rule configuration. See `rule` Block below.

      • get

        public static IndexingRule get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               IndexingRuleState state,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.