1. Packages
  2. Datadog Provider
  3. API Docs
  4. TagPipelineRulesets
Datadog v4.60.0 published on Friday, Nov 21, 2025 by Pulumi
datadog logo
Datadog v4.60.0 published on Friday, Nov 21, 2025 by Pulumi

    Provides a Datadog Tag Pipeline Ruleset Order resource that can be used to manage the order of Tag Pipeline Rulesets.

    Example Usage

    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    
    resources:
      # ============================================================================
      # Example 1: Basic Usage - Manage the order of tag pipeline rulesets
      # ============================================================================
      # This example shows the default behavior where UI-defined rulesets that are
      # not in Terraform will be preserved at the end of the order.
      first:
        type: datadog:TagPipelineRuleset
        properties:
          name: Standardize Environment Tags
          enabled: true
          rules:
            - name: map-env
              enabled: true
              mapping:
                - destinationKey: env
                  ifNotExists: true
                  sourceKeys:
                    - environment
                    - stage
      second:
        type: datadog:TagPipelineRuleset
        properties:
          name: Assign Team Tags
          enabled: true
          rules:
            - name: assign-team
              enabled: true
              query:
                - query: service:web* OR service:api*
                  ifNotExists: false
                  addition:
                    - key: team
                      value: backend
      third:
        type: datadog:TagPipelineRuleset
        properties:
          name: Enrich Service Metadata
          enabled: true
          rules:
            - name: lookup-service
              enabled: true
              referenceTable:
                - tableName: service_catalog
                  caseInsensitivity: true
                  ifNotExists: true
                  sourceKeys:
                    - service
                  fieldPairs:
                    - inputColumn: owner_team
                      outputKey: owner
      # Manage the order of tag pipeline rulesets
      # Rulesets are executed in the order specified in ruleset_ids
      # UI-defined rulesets not in this list will be preserved at the end
      order:
        type: datadog:TagPipelineRulesets
        properties:
          rulesetIds:
            - ${first.id}
            - ${second.id}
            - ${third.id}
      # ============================================================================
      # Example 2: Override UI-defined rulesets (override_ui_defined_resources = true)
      # ============================================================================
      # When set to true, any rulesets created via the UI that are not defined in Terraform
      # will be automatically deleted during pulumi up.
      managedFirst:
        type: datadog:TagPipelineRuleset
        name: managed_first
        properties:
          name: Standardize Environment Tags
          enabled: true
          rules:
            - name: map-env
              enabled: true
              mapping:
                - destinationKey: env
                  ifNotExists: true
                  sourceKeys:
                    - environment
                    - stage
      managedSecond:
        type: datadog:TagPipelineRuleset
        name: managed_second
        properties:
          name: Assign Team Tags
          enabled: true
          rules:
            - name: assign-team
              enabled: true
              query:
                - query: service:web*
                  ifNotExists: false
                  addition:
                    - key: team
                      value: frontend
      # Manage order with override_ui_defined_resources = true
      # This will delete any rulesets created via the UI that are not in this list
      orderOverride:
        type: datadog:TagPipelineRulesets
        name: order_override
        properties:
          overrideUiDefinedResources: true
          rulesetIds:
            - ${managedFirst.id}
            - ${managedSecond.id}
      # ============================================================================
      # Example 3: Preserve UI-defined rulesets (override_ui_defined_resources = false)
      # ============================================================================
      # When set to false (default), UI-defined rulesets that are not in Terraform
      # will be preserved at the end of the order. However, if unmanaged rulesets
      # are in the middle of the order, Terraform will error and require you to either:
      # 1. Import the unmanaged rulesets
      # 2. Set override_ui_defined_resources = true
      # 3. Manually reorder or delete them in the Datadog UI
      preserveFirst:
        type: datadog:TagPipelineRuleset
        name: preserve_first
        properties:
          name: Standardize Environment Tags
          enabled: true
          rules:
            - name: map-env
              enabled: true
              mapping:
                - destinationKey: env
                  ifNotExists: true
                  sourceKeys:
                    - environment
                    - stage
      preserveSecond:
        type: datadog:TagPipelineRuleset
        name: preserve_second
        properties:
          name: Assign Team Tags
          enabled: true
          rules:
            - name: assign-team
              enabled: true
              query:
                - query: service:web*
                  ifNotExists: false
                  addition:
                    - key: team
                      value: frontend
      # Manage order with override_ui_defined_resources = false (default)
      # UI-defined rulesets will be preserved at the end of the order
      # Terraform will warn if unmanaged rulesets exist at the end
      # Terraform will error if unmanaged rulesets are in the middle
      orderPreserve:
        type: datadog:TagPipelineRulesets
        name: order_preserve
        properties:
          overrideUiDefinedResources: false
          rulesetIds:
            - ${preserveFirst.id}
            - ${preserveSecond.id}
    

    Create TagPipelineRulesets Resource

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

    Constructor syntax

    new TagPipelineRulesets(name: string, args: TagPipelineRulesetsArgs, opts?: CustomResourceOptions);
    @overload
    def TagPipelineRulesets(resource_name: str,
                            args: TagPipelineRulesetsArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def TagPipelineRulesets(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            ruleset_ids: Optional[Sequence[str]] = None,
                            override_ui_defined_resources: Optional[bool] = None)
    func NewTagPipelineRulesets(ctx *Context, name string, args TagPipelineRulesetsArgs, opts ...ResourceOption) (*TagPipelineRulesets, error)
    public TagPipelineRulesets(string name, TagPipelineRulesetsArgs args, CustomResourceOptions? opts = null)
    public TagPipelineRulesets(String name, TagPipelineRulesetsArgs args)
    public TagPipelineRulesets(String name, TagPipelineRulesetsArgs args, CustomResourceOptions options)
    
    type: datadog:TagPipelineRulesets
    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 TagPipelineRulesetsArgs
    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 TagPipelineRulesetsArgs
    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 TagPipelineRulesetsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TagPipelineRulesetsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TagPipelineRulesetsArgs
    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 tagPipelineRulesetsResource = new Datadog.TagPipelineRulesets("tagPipelineRulesetsResource", new()
    {
        RulesetIds = new[]
        {
            "string",
        },
        OverrideUiDefinedResources = false,
    });
    
    example, err := datadog.NewTagPipelineRulesets(ctx, "tagPipelineRulesetsResource", &datadog.TagPipelineRulesetsArgs{
    	RulesetIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	OverrideUiDefinedResources: pulumi.Bool(false),
    })
    
    var tagPipelineRulesetsResource = new TagPipelineRulesets("tagPipelineRulesetsResource", TagPipelineRulesetsArgs.builder()
        .rulesetIds("string")
        .overrideUiDefinedResources(false)
        .build());
    
    tag_pipeline_rulesets_resource = datadog.TagPipelineRulesets("tagPipelineRulesetsResource",
        ruleset_ids=["string"],
        override_ui_defined_resources=False)
    
    const tagPipelineRulesetsResource = new datadog.TagPipelineRulesets("tagPipelineRulesetsResource", {
        rulesetIds: ["string"],
        overrideUiDefinedResources: false,
    });
    
    type: datadog:TagPipelineRulesets
    properties:
        overrideUiDefinedResources: false
        rulesetIds:
            - string
    

    TagPipelineRulesets 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 TagPipelineRulesets resource accepts the following input properties:

    RulesetIds List<string>
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    OverrideUiDefinedResources bool
    RulesetIds []string
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    OverrideUiDefinedResources bool
    rulesetIds List<String>
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    overrideUiDefinedResources Boolean
    rulesetIds string[]
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    overrideUiDefinedResources boolean
    ruleset_ids Sequence[str]
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    override_ui_defined_resources bool
    rulesetIds List<String>
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    overrideUiDefinedResources Boolean

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TagPipelineRulesets Resource

    Get an existing TagPipelineRulesets 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?: TagPipelineRulesetsState, opts?: CustomResourceOptions): TagPipelineRulesets
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            override_ui_defined_resources: Optional[bool] = None,
            ruleset_ids: Optional[Sequence[str]] = None) -> TagPipelineRulesets
    func GetTagPipelineRulesets(ctx *Context, name string, id IDInput, state *TagPipelineRulesetsState, opts ...ResourceOption) (*TagPipelineRulesets, error)
    public static TagPipelineRulesets Get(string name, Input<string> id, TagPipelineRulesetsState? state, CustomResourceOptions? opts = null)
    public static TagPipelineRulesets get(String name, Output<String> id, TagPipelineRulesetsState state, CustomResourceOptions options)
    resources:  _:    type: datadog:TagPipelineRulesets    get:      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:
    OverrideUiDefinedResources bool
    RulesetIds List<string>
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    OverrideUiDefinedResources bool
    RulesetIds []string
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    overrideUiDefinedResources Boolean
    rulesetIds List<String>
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    overrideUiDefinedResources boolean
    rulesetIds string[]
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    override_ui_defined_resources bool
    ruleset_ids Sequence[str]
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.
    overrideUiDefinedResources Boolean
    rulesetIds List<String>
    The list of Tag Pipeline Ruleset IDs, in order. Rulesets are executed in the order specified in this list.

    Import

    The pulumi import command can be used, for example:

    $ pulumi import datadog:index/tagPipelineRulesets:TagPipelineRulesets my_rulesets order
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Datadog v4.60.0 published on Friday, Nov 21, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate