Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Datadog Provider
  4. API Docs
  5. TagIndexingRule
Viewing docs for Datadog v5.6.0
published on Thursday, Jun 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

datadog.TagIndexingRule

datadog logo
Viewing docs for Datadog v5.6.0
published on Thursday, Jun 18, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

    Provides a Datadog Tag Indexing Rule resource. Tag indexing rules control which tag keys are indexed for metrics, reducing cardinality costs while preserving queryability.

    Example Usage

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

const example = new datadog.TagIndexingRule("example", {
    name: "Index env and service tags for all web metrics",
    metricNameMatches: [
        "web.*",
        "http.*",
    ],
    tags: [
        "env",
        "service",
        "version",
    ],
    excludeTagsMode: false,
    options: {
        version: 1,
        data: {
            managePreexistingMetrics: true,
            overridePreviousRules: false,
        },
    },
});

    import pulumi
import pulumi_datadog as datadog

example = datadog.TagIndexingRule("example",
    name="Index env and service tags for all web metrics",
    metric_name_matches=[
        "web.*",
        "http.*",
    ],
    tags=[
        "env",
        "service",
        "version",
    ],
    exclude_tags_mode=False,
    options={
        "version": 1,
        "data": {
            "manage_preexisting_metrics": True,
            "override_previous_rules": False,
        },
    })

    package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v5/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datadog.NewTagIndexingRule(ctx, "example", &datadog.TagIndexingRuleArgs{
			Name: pulumi.String("Index env and service tags for all web metrics"),
			MetricNameMatches: pulumi.StringArray{
				pulumi.String("web.*"),
				pulumi.String("http.*"),
			},
			Tags: pulumi.StringArray{
				pulumi.String("env"),
				pulumi.String("service"),
				pulumi.String("version"),
			},
			ExcludeTagsMode: pulumi.Bool(false),
			Options: &datadog.TagIndexingRuleOptionsArgs{
				Version: pulumi.Int(1),
				Data: &datadog.TagIndexingRuleOptionsDataArgs{
					ManagePreexistingMetrics: pulumi.Bool(true),
					OverridePreviousRules:    pulumi.Bool(false),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;

return await Deployment.RunAsync(() => 
{
    var example = new Datadog.TagIndexingRule("example", new()
    {
        Name = "Index env and service tags for all web metrics",
        MetricNameMatches = new[]
        {
            "web.*",
            "http.*",
        },
        Tags = new[]
        {
            "env",
            "service",
            "version",
        },
        ExcludeTagsMode = false,
        Options = new Datadog.Inputs.TagIndexingRuleOptionsArgs
        {
            Version = 1,
            Data = new Datadog.Inputs.TagIndexingRuleOptionsDataArgs
            {
                ManagePreexistingMetrics = true,
                OverridePreviousRules = false,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.TagIndexingRule;
import com.pulumi.datadog.TagIndexingRuleArgs;
import com.pulumi.datadog.inputs.TagIndexingRuleOptionsArgs;
import com.pulumi.datadog.inputs.TagIndexingRuleOptionsDataArgs;
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 TagIndexingRule("example", TagIndexingRuleArgs.builder()
            .name("Index env and service tags for all web metrics")
            .metricNameMatches(            
                "web.*",
                "http.*")
            .tags(            
                "env",
                "service",
                "version")
            .excludeTagsMode(false)
            .options(TagIndexingRuleOptionsArgs.builder()
                .version(1)
                .data(TagIndexingRuleOptionsDataArgs.builder()
                    .managePreexistingMetrics(true)
                    .overridePreviousRules(false)
                    .build())
                .build())
            .build());

    }
}

    resources:
  example:
    type: datadog:TagIndexingRule
    properties:
      name: Index env and service tags for all web metrics
      metricNameMatches:
        - web.*
        - http.*
      tags:
        - env
        - service
        - version
      excludeTagsMode: false
      options:
        version: 1
        data:
          managePreexistingMetrics: true
          overridePreviousRules: false

    pulumi {
  required_providers {
    datadog = {
      source = "pulumi/datadog"
    }
  }
}

resource "datadog_tagindexingrule" "example" {
  name                = "Index env and service tags for all web metrics"
  metric_name_matches = ["web.*", "http.*"]
  tags                = ["env", "service", "version"]
  exclude_tags_mode   = false
  options = {
    version = 1
    data = {
      manage_preexisting_metrics = true
      override_previous_rules    = false
    }
  }
}

    Create TagIndexingRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TagIndexingRule(name: string, args: TagIndexingRuleArgs, opts?: CustomResourceOptions);
    @overload
def TagIndexingRule(resource_name: str,
                    args: TagIndexingRuleArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def TagIndexingRule(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    metric_name_matches: Optional[Sequence[str]] = None,
                    name: Optional[str] = None,
                    exclude_tags_mode: Optional[bool] = None,
                    ignored_metric_name_matches: Optional[Sequence[str]] = None,
                    options: Optional[TagIndexingRuleOptionsArgs] = None,
                    tags: Optional[Sequence[str]] = None)
    func NewTagIndexingRule(ctx *Context, name string, args TagIndexingRuleArgs, opts ...ResourceOption) (*TagIndexingRule, error)
    public TagIndexingRule(string name, TagIndexingRuleArgs args, CustomResourceOptions? opts = null)
    public TagIndexingRule(String name, TagIndexingRuleArgs args)
public TagIndexingRule(String name, TagIndexingRuleArgs args, CustomResourceOptions options)

    type: datadog:TagIndexingRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "datadog_tagindexingrule" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args TagIndexingRuleArgs
    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 TagIndexingRuleArgs
    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 TagIndexingRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagIndexingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagIndexingRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var tagIndexingRuleResource = new Datadog.TagIndexingRule("tagIndexingRuleResource", new()
{
    MetricNameMatches = new[]
    {
        "string",
    },
    Name = "string",
    ExcludeTagsMode = false,
    IgnoredMetricNameMatches = new[]
    {
        "string",
    },
    Options = new Datadog.Inputs.TagIndexingRuleOptionsArgs
    {
        Data = new Datadog.Inputs.TagIndexingRuleOptionsDataArgs
        {
            DynamicTags = new Datadog.Inputs.TagIndexingRuleOptionsDataDynamicTagsArgs
            {
                QueriedTagsWindowSeconds = 0,
                RelatedAssetTags = false,
            },
            ManagePreexistingMetrics = false,
            MetricMatch = new Datadog.Inputs.TagIndexingRuleOptionsDataMetricMatchArgs
            {
                IsQueried = false,
                NotQueried = false,
                NotUsedInAssets = false,
                QueriedWindowSeconds = 0,
                UsedInAssets = false,
            },
            OverridePreviousRules = false,
        },
        Version = 0,
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := datadog.NewTagIndexingRule(ctx, "tagIndexingRuleResource", &datadog.TagIndexingRuleArgs{
	MetricNameMatches: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:            pulumi.String("string"),
	ExcludeTagsMode: pulumi.Bool(false),
	IgnoredMetricNameMatches: pulumi.StringArray{
		pulumi.String("string"),
	},
	Options: &datadog.TagIndexingRuleOptionsArgs{
		Data: &datadog.TagIndexingRuleOptionsDataArgs{
			DynamicTags: &datadog.TagIndexingRuleOptionsDataDynamicTagsArgs{
				QueriedTagsWindowSeconds: pulumi.Int(0),
				RelatedAssetTags:         pulumi.Bool(false),
			},
			ManagePreexistingMetrics: pulumi.Bool(false),
			MetricMatch: &datadog.TagIndexingRuleOptionsDataMetricMatchArgs{
				IsQueried:            pulumi.Bool(false),
				NotQueried:           pulumi.Bool(false),
				NotUsedInAssets:      pulumi.Bool(false),
				QueriedWindowSeconds: pulumi.Int(0),
				UsedInAssets:         pulumi.Bool(false),
			},
			OverridePreviousRules: pulumi.Bool(false),
		},
		Version: pulumi.Int(0),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "datadog_tagindexingrule" "tagIndexingRuleResource" {
  metric_name_matches         = ["string"]
  name                        = "string"
  exclude_tags_mode           = false
  ignored_metric_name_matches = ["string"]
  options = {
    data = {
      dynamic_tags = {
        queried_tags_window_seconds = 0
        related_asset_tags          = false
      }
      manage_preexisting_metrics = false
      metric_match = {
        is_queried             = false
        not_queried            = false
        not_used_in_assets     = false
        queried_window_seconds = 0
        used_in_assets         = false
      }
      override_previous_rules = false
    }
    version = 0
  }
  tags = ["string"]
}

    var tagIndexingRuleResource = new TagIndexingRule("tagIndexingRuleResource", TagIndexingRuleArgs.builder()
    .metricNameMatches("string")
    .name("string")
    .excludeTagsMode(false)
    .ignoredMetricNameMatches("string")
    .options(TagIndexingRuleOptionsArgs.builder()
        .data(TagIndexingRuleOptionsDataArgs.builder()
            .dynamicTags(TagIndexingRuleOptionsDataDynamicTagsArgs.builder()
                .queriedTagsWindowSeconds(0)
                .relatedAssetTags(false)
                .build())
            .managePreexistingMetrics(false)
            .metricMatch(TagIndexingRuleOptionsDataMetricMatchArgs.builder()
                .isQueried(false)
                .notQueried(false)
                .notUsedInAssets(false)
                .queriedWindowSeconds(0)
                .usedInAssets(false)
                .build())
            .overridePreviousRules(false)
            .build())
        .version(0)
        .build())
    .tags("string")
    .build());

    tag_indexing_rule_resource = datadog.TagIndexingRule("tagIndexingRuleResource",
    metric_name_matches=["string"],
    name="string",
    exclude_tags_mode=False,
    ignored_metric_name_matches=["string"],
    options={
        "data": {
            "dynamic_tags": {
                "queried_tags_window_seconds": 0,
                "related_asset_tags": False,
            },
            "manage_preexisting_metrics": False,
            "metric_match": {
                "is_queried": False,
                "not_queried": False,
                "not_used_in_assets": False,
                "queried_window_seconds": 0,
                "used_in_assets": False,
            },
            "override_previous_rules": False,
        },
        "version": 0,
    },
    tags=["string"])

    const tagIndexingRuleResource = new datadog.TagIndexingRule("tagIndexingRuleResource", {
    metricNameMatches: ["string"],
    name: "string",
    excludeTagsMode: false,
    ignoredMetricNameMatches: ["string"],
    options: {
        data: {
            dynamicTags: {
                queriedTagsWindowSeconds: 0,
                relatedAssetTags: false,
            },
            managePreexistingMetrics: false,
            metricMatch: {
                isQueried: false,
                notQueried: false,
                notUsedInAssets: false,
                queriedWindowSeconds: 0,
                usedInAssets: false,
            },
            overridePreviousRules: false,
        },
        version: 0,
    },
    tags: ["string"],
});

    type: datadog:TagIndexingRule
properties:
    excludeTagsMode: false
    ignoredMetricNameMatches:
        - string
    metricNameMatches:
        - string
    name: string
    options:
        data:
            dynamicTags:
                queriedTagsWindowSeconds: 0
                relatedAssetTags: false
            managePreexistingMetrics: false
            metricMatch:
                isQueried: false
                notQueried: false
                notUsedInAssets: false
                queriedWindowSeconds: 0
                usedInAssets: false
            overridePreviousRules: false
        version: 0
    tags:
        - string

    TagIndexingRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TagIndexingRule resource accepts the following input properties:

    MetricNameMatches List<string>
    Metric name prefixes (glob patterns) this rule applies to.
    Name string
    Human-readable name for the rule.
    ExcludeTagsMode bool
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    IgnoredMetricNameMatches List<string>
    Metric name prefixes excluded from the rule's scope.
    Options TagIndexingRuleOptions
    Versioned configuration options for the rule.
    Tags List<string>
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    MetricNameMatches []string
    Metric name prefixes (glob patterns) this rule applies to.
    Name string
    Human-readable name for the rule.
    ExcludeTagsMode bool
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    IgnoredMetricNameMatches []string
    Metric name prefixes excluded from the rule's scope.
    Options TagIndexingRuleOptionsArgs
    Versioned configuration options for the rule.
    Tags []string
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    metric_name_matches list(string)
    Metric name prefixes (glob patterns) this rule applies to.
    name string
    Human-readable name for the rule.
    exclude_tags_mode bool
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignored_metric_name_matches list(string)
    Metric name prefixes excluded from the rule's scope.
    options object
    Versioned configuration options for the rule.
    tags list(string)
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    metricNameMatches List<String>
    Metric name prefixes (glob patterns) this rule applies to.
    name String
    Human-readable name for the rule.
    excludeTagsMode Boolean
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignoredMetricNameMatches List<String>
    Metric name prefixes excluded from the rule's scope.
    options TagIndexingRuleOptions
    Versioned configuration options for the rule.
    tags List<String>
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    metricNameMatches string[]
    Metric name prefixes (glob patterns) this rule applies to.
    name string
    Human-readable name for the rule.
    excludeTagsMode boolean
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignoredMetricNameMatches string[]
    Metric name prefixes excluded from the rule's scope.
    options TagIndexingRuleOptions
    Versioned configuration options for the rule.
    tags string[]
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    metric_name_matches Sequence[str]
    Metric name prefixes (glob patterns) this rule applies to.
    name str
    Human-readable name for the rule.
    exclude_tags_mode bool
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignored_metric_name_matches Sequence[str]
    Metric name prefixes excluded from the rule's scope.
    options TagIndexingRuleOptionsArgs
    Versioned configuration options for the rule.
    tags Sequence[str]
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    metricNameMatches List<String>
    Metric name prefixes (glob patterns) this rule applies to.
    name String
    Human-readable name for the rule.
    excludeTagsMode Boolean
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignoredMetricNameMatches List<String>
    Metric name prefixes excluded from the rule's scope.
    options Property Map
    Versioned configuration options for the rule.
    tags List<String>
    Tag keys this rule includes or excludes, depending on excludetagsmode.

    Outputs

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

    CreatedAt string
    Timestamp when the rule was created.
    CreatedByHandle string
    Handle of the user who created the rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedAt string
    Timestamp when the rule was last modified.
    ModifiedByHandle string
    Handle of the user who last modified the rule.
    RuleOrder int
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    CreatedAt string
    Timestamp when the rule was created.
    CreatedByHandle string
    Handle of the user who created the rule.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedAt string
    Timestamp when the rule was last modified.
    ModifiedByHandle string
    Handle of the user who last modified the rule.
    RuleOrder int
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    created_at string
    Timestamp when the rule was created.
    created_by_handle string
    Handle of the user who created the rule.
    id string
    The provider-assigned unique ID for this managed resource.
    modified_at string
    Timestamp when the rule was last modified.
    modified_by_handle string
    Handle of the user who last modified the rule.
    rule_order number
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    createdAt String
    Timestamp when the rule was created.
    createdByHandle String
    Handle of the user who created the rule.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedAt String
    Timestamp when the rule was last modified.
    modifiedByHandle String
    Handle of the user who last modified the rule.
    ruleOrder Integer
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    createdAt string
    Timestamp when the rule was created.
    createdByHandle string
    Handle of the user who created the rule.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedAt string
    Timestamp when the rule was last modified.
    modifiedByHandle string
    Handle of the user who last modified the rule.
    ruleOrder number
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    created_at str
    Timestamp when the rule was created.
    created_by_handle str
    Handle of the user who created the rule.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_at str
    Timestamp when the rule was last modified.
    modified_by_handle str
    Handle of the user who last modified the rule.
    rule_order int
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    createdAt String
    Timestamp when the rule was created.
    createdByHandle String
    Handle of the user who created the rule.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedAt String
    Timestamp when the rule was last modified.
    modifiedByHandle String
    Handle of the user who last modified the rule.
    ruleOrder Number
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.

    Look up Existing TagIndexingRule Resource

    Get an existing TagIndexingRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TagIndexingRuleState, opts?: CustomResourceOptions): TagIndexingRule
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        created_by_handle: Optional[str] = None,
        exclude_tags_mode: Optional[bool] = None,
        ignored_metric_name_matches: Optional[Sequence[str]] = None,
        metric_name_matches: Optional[Sequence[str]] = None,
        modified_at: Optional[str] = None,
        modified_by_handle: Optional[str] = None,
        name: Optional[str] = None,
        options: Optional[TagIndexingRuleOptionsArgs] = None,
        rule_order: Optional[int] = None,
        tags: Optional[Sequence[str]] = None) -> TagIndexingRule
    func GetTagIndexingRule(ctx *Context, name string, id IDInput, state *TagIndexingRuleState, opts ...ResourceOption) (*TagIndexingRule, error)
    public static TagIndexingRule Get(string name, Input<string> id, TagIndexingRuleState? state, CustomResourceOptions? opts = null)
    public static TagIndexingRule get(String name, Output<String> id, TagIndexingRuleState state, CustomResourceOptions options)
    resources:  _:    type: datadog:TagIndexingRule    get:      id: ${id}
    import {
  to = datadog_tagindexingrule.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    Timestamp when the rule was created.
    CreatedByHandle string
    Handle of the user who created the rule.
    ExcludeTagsMode bool
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    IgnoredMetricNameMatches List<string>
    Metric name prefixes excluded from the rule's scope.
    MetricNameMatches List<string>
    Metric name prefixes (glob patterns) this rule applies to.
    ModifiedAt string
    Timestamp when the rule was last modified.
    ModifiedByHandle string
    Handle of the user who last modified the rule.
    Name string
    Human-readable name for the rule.
    Options TagIndexingRuleOptions
    Versioned configuration options for the rule.
    RuleOrder int
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    Tags List<string>
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    CreatedAt string
    Timestamp when the rule was created.
    CreatedByHandle string
    Handle of the user who created the rule.
    ExcludeTagsMode bool
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    IgnoredMetricNameMatches []string
    Metric name prefixes excluded from the rule's scope.
    MetricNameMatches []string
    Metric name prefixes (glob patterns) this rule applies to.
    ModifiedAt string
    Timestamp when the rule was last modified.
    ModifiedByHandle string
    Handle of the user who last modified the rule.
    Name string
    Human-readable name for the rule.
    Options TagIndexingRuleOptionsArgs
    Versioned configuration options for the rule.
    RuleOrder int
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    Tags []string
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    created_at string
    Timestamp when the rule was created.
    created_by_handle string
    Handle of the user who created the rule.
    exclude_tags_mode bool
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignored_metric_name_matches list(string)
    Metric name prefixes excluded from the rule's scope.
    metric_name_matches list(string)
    Metric name prefixes (glob patterns) this rule applies to.
    modified_at string
    Timestamp when the rule was last modified.
    modified_by_handle string
    Handle of the user who last modified the rule.
    name string
    Human-readable name for the rule.
    options object
    Versioned configuration options for the rule.
    rule_order number
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    tags list(string)
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    createdAt String
    Timestamp when the rule was created.
    createdByHandle String
    Handle of the user who created the rule.
    excludeTagsMode Boolean
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignoredMetricNameMatches List<String>
    Metric name prefixes excluded from the rule's scope.
    metricNameMatches List<String>
    Metric name prefixes (glob patterns) this rule applies to.
    modifiedAt String
    Timestamp when the rule was last modified.
    modifiedByHandle String
    Handle of the user who last modified the rule.
    name String
    Human-readable name for the rule.
    options TagIndexingRuleOptions
    Versioned configuration options for the rule.
    ruleOrder Integer
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    tags List<String>
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    createdAt string
    Timestamp when the rule was created.
    createdByHandle string
    Handle of the user who created the rule.
    excludeTagsMode boolean
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignoredMetricNameMatches string[]
    Metric name prefixes excluded from the rule's scope.
    metricNameMatches string[]
    Metric name prefixes (glob patterns) this rule applies to.
    modifiedAt string
    Timestamp when the rule was last modified.
    modifiedByHandle string
    Handle of the user who last modified the rule.
    name string
    Human-readable name for the rule.
    options TagIndexingRuleOptions
    Versioned configuration options for the rule.
    ruleOrder number
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    tags string[]
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    created_at str
    Timestamp when the rule was created.
    created_by_handle str
    Handle of the user who created the rule.
    exclude_tags_mode bool
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignored_metric_name_matches Sequence[str]
    Metric name prefixes excluded from the rule's scope.
    metric_name_matches Sequence[str]
    Metric name prefixes (glob patterns) this rule applies to.
    modified_at str
    Timestamp when the rule was last modified.
    modified_by_handle str
    Handle of the user who last modified the rule.
    name str
    Human-readable name for the rule.
    options TagIndexingRuleOptionsArgs
    Versioned configuration options for the rule.
    rule_order int
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    tags Sequence[str]
    Tag keys this rule includes or excludes, depending on excludetagsmode.
    createdAt String
    Timestamp when the rule was created.
    createdByHandle String
    Handle of the user who created the rule.
    excludeTagsMode Boolean
    When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags. Defaults to false.
    ignoredMetricNameMatches List<String>
    Metric name prefixes excluded from the rule's scope.
    metricNameMatches List<String>
    Metric name prefixes (glob patterns) this rule applies to.
    modifiedAt String
    Timestamp when the rule was last modified.
    modifiedByHandle String
    Handle of the user who last modified the rule.
    name String
    Human-readable name for the rule.
    options Property Map
    Versioned configuration options for the rule.
    ruleOrder Number
    Evaluation order within the org. Lower values are evaluated first. Server-assigned on create; use datadog.TagIndexingRuleOrder to control ordering.
    tags List<String>
    Tag keys this rule includes or excludes, depending on excludetagsmode.

    Supporting Types

    TagIndexingRuleOptions, TagIndexingRuleOptionsArgs

    Data TagIndexingRuleOptionsData
    Behavioral options for how the rule applies to metrics, including backfill and override behavior.
    Version int
    Options schema version. Only 1 is supported.
    Data TagIndexingRuleOptionsData
    Behavioral options for how the rule applies to metrics, including backfill and override behavior.
    Version int
    Options schema version. Only 1 is supported.
    data object
    Behavioral options for how the rule applies to metrics, including backfill and override behavior.
    version number
    Options schema version. Only 1 is supported.
    data TagIndexingRuleOptionsData
    Behavioral options for how the rule applies to metrics, including backfill and override behavior.
    version Integer
    Options schema version. Only 1 is supported.
    data TagIndexingRuleOptionsData
    Behavioral options for how the rule applies to metrics, including backfill and override behavior.
    version number
    Options schema version. Only 1 is supported.
    data TagIndexingRuleOptionsData
    Behavioral options for how the rule applies to metrics, including backfill and override behavior.
    version int
    Options schema version. Only 1 is supported.
    data Property Map
    Behavioral options for how the rule applies to metrics, including backfill and override behavior.
    version Number
    Options schema version. Only 1 is supported.

    TagIndexingRuleOptionsData, TagIndexingRuleOptionsDataArgs

    DynamicTags TagIndexingRuleOptionsDataDynamicTags
    Configuration for including dynamically queried tags.
    ManagePreexistingMetrics bool
    When true, the rule applies to metrics ingested before the rule was created.
    MetricMatch TagIndexingRuleOptionsDataMetricMatch
    Criteria for matching metrics based on query state.
    OverridePreviousRules bool
    When true, this rule's tag list overrides tags configured by earlier rules for the same metric.
    DynamicTags TagIndexingRuleOptionsDataDynamicTags
    Configuration for including dynamically queried tags.
    ManagePreexistingMetrics bool
    When true, the rule applies to metrics ingested before the rule was created.
    MetricMatch TagIndexingRuleOptionsDataMetricMatch
    Criteria for matching metrics based on query state.
    OverridePreviousRules bool
    When true, this rule's tag list overrides tags configured by earlier rules for the same metric.
    dynamic_tags object
    Configuration for including dynamically queried tags.
    manage_preexisting_metrics bool
    When true, the rule applies to metrics ingested before the rule was created.
    metric_match object
    Criteria for matching metrics based on query state.
    override_previous_rules bool
    When true, this rule's tag list overrides tags configured by earlier rules for the same metric.
    dynamicTags TagIndexingRuleOptionsDataDynamicTags
    Configuration for including dynamically queried tags.
    managePreexistingMetrics Boolean
    When true, the rule applies to metrics ingested before the rule was created.
    metricMatch TagIndexingRuleOptionsDataMetricMatch
    Criteria for matching metrics based on query state.
    overridePreviousRules Boolean
    When true, this rule's tag list overrides tags configured by earlier rules for the same metric.
    dynamicTags TagIndexingRuleOptionsDataDynamicTags
    Configuration for including dynamically queried tags.
    managePreexistingMetrics boolean
    When true, the rule applies to metrics ingested before the rule was created.
    metricMatch TagIndexingRuleOptionsDataMetricMatch
    Criteria for matching metrics based on query state.
    overridePreviousRules boolean
    When true, this rule's tag list overrides tags configured by earlier rules for the same metric.
    dynamic_tags TagIndexingRuleOptionsDataDynamicTags
    Configuration for including dynamically queried tags.
    manage_preexisting_metrics bool
    When true, the rule applies to metrics ingested before the rule was created.
    metric_match TagIndexingRuleOptionsDataMetricMatch
    Criteria for matching metrics based on query state.
    override_previous_rules bool
    When true, this rule's tag list overrides tags configured by earlier rules for the same metric.
    dynamicTags Property Map
    Configuration for including dynamically queried tags.
    managePreexistingMetrics Boolean
    When true, the rule applies to metrics ingested before the rule was created.
    metricMatch Property Map
    Criteria for matching metrics based on query state.
    overridePreviousRules Boolean
    When true, this rule's tag list overrides tags configured by earlier rules for the same metric.

    TagIndexingRuleOptionsDataDynamicTags, TagIndexingRuleOptionsDataDynamicTagsArgs

    QueriedTagsWindowSeconds int
    Lookback window for determining which tags were recently queried.
    RelatedAssetTags bool
    When true, tags from related assets are included.
    QueriedTagsWindowSeconds int
    Lookback window for determining which tags were recently queried.
    RelatedAssetTags bool
    When true, tags from related assets are included.
    queried_tags_window_seconds number
    Lookback window for determining which tags were recently queried.
    related_asset_tags bool
    When true, tags from related assets are included.
    queriedTagsWindowSeconds Integer
    Lookback window for determining which tags were recently queried.
    relatedAssetTags Boolean
    When true, tags from related assets are included.
    queriedTagsWindowSeconds number
    Lookback window for determining which tags were recently queried.
    relatedAssetTags boolean
    When true, tags from related assets are included.
    queried_tags_window_seconds int
    Lookback window for determining which tags were recently queried.
    related_asset_tags bool
    When true, tags from related assets are included.
    queriedTagsWindowSeconds Number
    Lookback window for determining which tags were recently queried.
    relatedAssetTags Boolean
    When true, tags from related assets are included.

    TagIndexingRuleOptionsDataMetricMatch, TagIndexingRuleOptionsDataMetricMatchArgs

    IsQueried bool
    Match metrics that are being queried.
    NotQueried bool
    Match metrics that are not being queried.
    NotUsedInAssets bool
    Match metrics not used in any dashboards or monitors.
    QueriedWindowSeconds int
    Window in seconds for evaluating query state.
    UsedInAssets bool
    Match metrics used in dashboards or monitors.
    IsQueried bool
    Match metrics that are being queried.
    NotQueried bool
    Match metrics that are not being queried.
    NotUsedInAssets bool
    Match metrics not used in any dashboards or monitors.
    QueriedWindowSeconds int
    Window in seconds for evaluating query state.
    UsedInAssets bool
    Match metrics used in dashboards or monitors.
    is_queried bool
    Match metrics that are being queried.
    not_queried bool
    Match metrics that are not being queried.
    not_used_in_assets bool
    Match metrics not used in any dashboards or monitors.
    queried_window_seconds number
    Window in seconds for evaluating query state.
    used_in_assets bool
    Match metrics used in dashboards or monitors.
    isQueried Boolean
    Match metrics that are being queried.
    notQueried Boolean
    Match metrics that are not being queried.
    notUsedInAssets Boolean
    Match metrics not used in any dashboards or monitors.
    queriedWindowSeconds Integer
    Window in seconds for evaluating query state.
    usedInAssets Boolean
    Match metrics used in dashboards or monitors.
    isQueried boolean
    Match metrics that are being queried.
    notQueried boolean
    Match metrics that are not being queried.
    notUsedInAssets boolean
    Match metrics not used in any dashboards or monitors.
    queriedWindowSeconds number
    Window in seconds for evaluating query state.
    usedInAssets boolean
    Match metrics used in dashboards or monitors.
    is_queried bool
    Match metrics that are being queried.
    not_queried bool
    Match metrics that are not being queried.
    not_used_in_assets bool
    Match metrics not used in any dashboards or monitors.
    queried_window_seconds int
    Window in seconds for evaluating query state.
    used_in_assets bool
    Match metrics used in dashboards or monitors.
    isQueried Boolean
    Match metrics that are being queried.
    notQueried Boolean
    Match metrics that are not being queried.
    notUsedInAssets Boolean
    Match metrics not used in any dashboards or monitors.
    queriedWindowSeconds Number
    Window in seconds for evaluating query state.
    usedInAssets Boolean
    Match metrics used in dashboards or monitors.

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Viewing docs for Datadog v5.6.0
    published on Thursday, Jun 18, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-datadog

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial