Datadog v4.58.0, Oct 16 25

Datadog v4.58.0 published on Thursday, Oct 16, 2025 by Pulumi

datadog.TagPipelineRuleset

Datadog v4.58.0 published on Thursday, Oct 16, 2025 by Pulumi

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  example:
    type: datadog:TagPipelineRuleset
    properties:
      name: Complete Tag Pipeline Example
      enabled: true
      rules:
        - name: standardize-environment
          enabled: true
          mapping:
            - destinationKey: env
              ifNotExists: true
              sourceKeys:
                - environment
                - stage
                - tier
        - name: assign-team-tags
          enabled: true
          query:
            - query: service:web* OR service:frontend*
              caseInsensitivity: true
              ifNotExists: true
              addition:
                - key: team
                  value: frontend
        - name: enrich-service-metadata
          enabled: true
          referenceTable:
            - tableName: service_catalog
              caseInsensitivity: true
              ifNotExists: true
              sourceKeys:
                - service
              fieldPairs:
                - inputColumn: owner_team
                  outputKey: owner
                - inputColumn: business_unit
                  outputKey: business_unit

Create TagPipelineRuleset Resource

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

Constructor syntax

new TagPipelineRuleset(name: string, args: TagPipelineRulesetArgs, opts?: CustomResourceOptions);

@overload
def TagPipelineRuleset(resource_name: str,
                       args: TagPipelineRulesetArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def TagPipelineRuleset(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       name: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       rules: Optional[Sequence[TagPipelineRulesetRuleArgs]] = None)

func NewTagPipelineRuleset(ctx *Context, name string, args TagPipelineRulesetArgs, opts ...ResourceOption) (*TagPipelineRuleset, error)

public TagPipelineRuleset(string name, TagPipelineRulesetArgs args, CustomResourceOptions? opts = null)

public TagPipelineRuleset(String name, TagPipelineRulesetArgs args)
public TagPipelineRuleset(String name, TagPipelineRulesetArgs args, CustomResourceOptions options)

type: datadog:TagPipelineRuleset
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 TagPipelineRulesetArgs: 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 TagPipelineRulesetArgs: 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 TagPipelineRulesetArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TagPipelineRulesetArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TagPipelineRulesetArgs: 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 tagPipelineRulesetResource = new Datadog.TagPipelineRuleset("tagPipelineRulesetResource", new()
{
    Name = "string",
    Enabled = false,
    Rules = new[]
    {
        new Datadog.Inputs.TagPipelineRulesetRuleArgs
        {
            Enabled = false,
            Name = "string",
            Mapping = new Datadog.Inputs.TagPipelineRulesetRuleMappingArgs
            {
                DestinationKey = "string",
                IfNotExists = false,
                SourceKeys = new[]
                {
                    "string",
                },
            },
            Metadata = 
            {
                { "string", "string" },
            },
            Query = new Datadog.Inputs.TagPipelineRulesetRuleQueryArgs
            {
                Addition = new Datadog.Inputs.TagPipelineRulesetRuleQueryAdditionArgs
                {
                    Key = "string",
                    Value = "string",
                },
                CaseInsensitivity = false,
                IfNotExists = false,
                Query = "string",
            },
            ReferenceTable = new Datadog.Inputs.TagPipelineRulesetRuleReferenceTableArgs
            {
                CaseInsensitivity = false,
                FieldPairs = new[]
                {
                    new Datadog.Inputs.TagPipelineRulesetRuleReferenceTableFieldPairArgs
                    {
                        InputColumn = "string",
                        OutputKey = "string",
                    },
                },
                IfNotExists = false,
                SourceKeys = new[]
                {
                    "string",
                },
                TableName = "string",
            },
        },
    },
});

example, err := datadog.NewTagPipelineRuleset(ctx, "tagPipelineRulesetResource", &datadog.TagPipelineRulesetArgs{
	Name:    pulumi.String("string"),
	Enabled: pulumi.Bool(false),
	Rules: datadog.TagPipelineRulesetRuleArray{
		&datadog.TagPipelineRulesetRuleArgs{
			Enabled: pulumi.Bool(false),
			Name:    pulumi.String("string"),
			Mapping: &datadog.TagPipelineRulesetRuleMappingArgs{
				DestinationKey: pulumi.String("string"),
				IfNotExists:    pulumi.Bool(false),
				SourceKeys: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			Metadata: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Query: &datadog.TagPipelineRulesetRuleQueryArgs{
				Addition: &datadog.TagPipelineRulesetRuleQueryAdditionArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
				CaseInsensitivity: pulumi.Bool(false),
				IfNotExists:       pulumi.Bool(false),
				Query:             pulumi.String("string"),
			},
			ReferenceTable: &datadog.TagPipelineRulesetRuleReferenceTableArgs{
				CaseInsensitivity: pulumi.Bool(false),
				FieldPairs: datadog.TagPipelineRulesetRuleReferenceTableFieldPairArray{
					&datadog.TagPipelineRulesetRuleReferenceTableFieldPairArgs{
						InputColumn: pulumi.String("string"),
						OutputKey:   pulumi.String("string"),
					},
				},
				IfNotExists: pulumi.Bool(false),
				SourceKeys: pulumi.StringArray{
					pulumi.String("string"),
				},
				TableName: pulumi.String("string"),
			},
		},
	},
})

var tagPipelineRulesetResource = new TagPipelineRuleset("tagPipelineRulesetResource", TagPipelineRulesetArgs.builder()
    .name("string")
    .enabled(false)
    .rules(TagPipelineRulesetRuleArgs.builder()
        .enabled(false)
        .name("string")
        .mapping(TagPipelineRulesetRuleMappingArgs.builder()
            .destinationKey("string")
            .ifNotExists(false)
            .sourceKeys("string")
            .build())
        .metadata(Map.of("string", "string"))
        .query(TagPipelineRulesetRuleQueryArgs.builder()
            .addition(TagPipelineRulesetRuleQueryAdditionArgs.builder()
                .key("string")
                .value("string")
                .build())
            .caseInsensitivity(false)
            .ifNotExists(false)
            .query("string")
            .build())
        .referenceTable(TagPipelineRulesetRuleReferenceTableArgs.builder()
            .caseInsensitivity(false)
            .fieldPairs(TagPipelineRulesetRuleReferenceTableFieldPairArgs.builder()
                .inputColumn("string")
                .outputKey("string")
                .build())
            .ifNotExists(false)
            .sourceKeys("string")
            .tableName("string")
            .build())
        .build())
    .build());

tag_pipeline_ruleset_resource = datadog.TagPipelineRuleset("tagPipelineRulesetResource",
    name="string",
    enabled=False,
    rules=[{
        "enabled": False,
        "name": "string",
        "mapping": {
            "destination_key": "string",
            "if_not_exists": False,
            "source_keys": ["string"],
        },
        "metadata": {
            "string": "string",
        },
        "query": {
            "addition": {
                "key": "string",
                "value": "string",
            },
            "case_insensitivity": False,
            "if_not_exists": False,
            "query": "string",
        },
        "reference_table": {
            "case_insensitivity": False,
            "field_pairs": [{
                "input_column": "string",
                "output_key": "string",
            }],
            "if_not_exists": False,
            "source_keys": ["string"],
            "table_name": "string",
        },
    }])

const tagPipelineRulesetResource = new datadog.TagPipelineRuleset("tagPipelineRulesetResource", {
    name: "string",
    enabled: false,
    rules: [{
        enabled: false,
        name: "string",
        mapping: {
            destinationKey: "string",
            ifNotExists: false,
            sourceKeys: ["string"],
        },
        metadata: {
            string: "string",
        },
        query: {
            addition: {
                key: "string",
                value: "string",
            },
            caseInsensitivity: false,
            ifNotExists: false,
            query: "string",
        },
        referenceTable: {
            caseInsensitivity: false,
            fieldPairs: [{
                inputColumn: "string",
                outputKey: "string",
            }],
            ifNotExists: false,
            sourceKeys: ["string"],
            tableName: "string",
        },
    }],
});

type: datadog:TagPipelineRuleset
properties:
    enabled: false
    name: string
    rules:
        - enabled: false
          mapping:
            destinationKey: string
            ifNotExists: false
            sourceKeys:
                - string
          metadata:
            string: string
          name: string
          query:
            addition:
                key: string
                value: string
            caseInsensitivity: false
            ifNotExists: false
            query: string
          referenceTable:
            caseInsensitivity: false
            fieldPairs:
                - inputColumn: string
                  outputKey: string
            ifNotExists: false
            sourceKeys:
                - string
            tableName: string

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

Name string: The name of the ruleset.
Enabled bool: Whether the ruleset is enabled.
Rules List<TagPipelineRulesetRule>: The rules in the ruleset.

Name string: The name of the ruleset.
Enabled bool: Whether the ruleset is enabled.
Rules []TagPipelineRulesetRuleArgs: The rules in the ruleset.

name String: The name of the ruleset.
enabled Boolean: Whether the ruleset is enabled.
rules List<TagPipelineRulesetRule>: The rules in the ruleset.

name string: The name of the ruleset.
enabled boolean: Whether the ruleset is enabled.
rules TagPipelineRulesetRule[]: The rules in the ruleset.

name str: The name of the ruleset.
enabled bool: Whether the ruleset is enabled.
rules Sequence[TagPipelineRulesetRuleArgs]: The rules in the ruleset.

name String: The name of the ruleset.
enabled Boolean: Whether the ruleset is enabled.
rules List<Property Map>: The rules in the ruleset.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Position int: The position of the ruleset in the pipeline.
Version int: The version of the ruleset.

Id string: The provider-assigned unique ID for this managed resource.
Position int: The position of the ruleset in the pipeline.
Version int: The version of the ruleset.

id String: The provider-assigned unique ID for this managed resource.
position Integer: The position of the ruleset in the pipeline.
version Integer: The version of the ruleset.

id string: The provider-assigned unique ID for this managed resource.
position number: The position of the ruleset in the pipeline.
version number: The version of the ruleset.

id str: The provider-assigned unique ID for this managed resource.
position int: The position of the ruleset in the pipeline.
version int: The version of the ruleset.

id String: The provider-assigned unique ID for this managed resource.
position Number: The position of the ruleset in the pipeline.
version Number: The version of the ruleset.

Look up Existing TagPipelineRuleset Resource

Get an existing TagPipelineRuleset 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?: TagPipelineRulesetState, opts?: CustomResourceOptions): TagPipelineRuleset

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        position: Optional[int] = None,
        rules: Optional[Sequence[TagPipelineRulesetRuleArgs]] = None,
        version: Optional[int] = None) -> TagPipelineRuleset

func GetTagPipelineRuleset(ctx *Context, name string, id IDInput, state *TagPipelineRulesetState, opts ...ResourceOption) (*TagPipelineRuleset, error)

public static TagPipelineRuleset Get(string name, Input<string> id, TagPipelineRulesetState? state, CustomResourceOptions? opts = null)

public static TagPipelineRuleset get(String name, Output<String> id, TagPipelineRulesetState state, CustomResourceOptions options)

resources:  _:    type: datadog:TagPipelineRuleset    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:

Enabled bool: Whether the ruleset is enabled.
Name string: The name of the ruleset.
Position int: The position of the ruleset in the pipeline.
Rules List<TagPipelineRulesetRule>: The rules in the ruleset.
Version int: The version of the ruleset.

Enabled bool: Whether the ruleset is enabled.
Name string: The name of the ruleset.
Position int: The position of the ruleset in the pipeline.
Rules []TagPipelineRulesetRuleArgs: The rules in the ruleset.
Version int: The version of the ruleset.

enabled Boolean: Whether the ruleset is enabled.
name String: The name of the ruleset.
position Integer: The position of the ruleset in the pipeline.
rules List<TagPipelineRulesetRule>: The rules in the ruleset.
version Integer: The version of the ruleset.

enabled boolean: Whether the ruleset is enabled.
name string: The name of the ruleset.
position number: The position of the ruleset in the pipeline.
rules TagPipelineRulesetRule[]: The rules in the ruleset.
version number: The version of the ruleset.

enabled bool: Whether the ruleset is enabled.
name str: The name of the ruleset.
position int: The position of the ruleset in the pipeline.
rules Sequence[TagPipelineRulesetRuleArgs]: The rules in the ruleset.
version int: The version of the ruleset.

enabled Boolean: Whether the ruleset is enabled.
name String: The name of the ruleset.
position Number: The position of the ruleset in the pipeline.
rules List<Property Map>: The rules in the ruleset.
version Number: The version of the ruleset.

Supporting Types

TagPipelineRulesetRule, TagPipelineRulesetRuleArgs

Enabled bool: Whether the rule is enabled.
Name string: The name of the rule.
Mapping TagPipelineRulesetRuleMapping: The mapping configuration for the rule.
Metadata Dictionary<string, string>: Rule metadata key-value pairs.
Query TagPipelineRulesetRuleQuery: The query configuration for the rule.
ReferenceTable TagPipelineRulesetRuleReferenceTable: The reference table configuration for the rule.

Enabled bool: Whether the rule is enabled.
Name string: The name of the rule.
Mapping TagPipelineRulesetRuleMapping: The mapping configuration for the rule.
Metadata map[string]string: Rule metadata key-value pairs.
Query TagPipelineRulesetRuleQuery: The query configuration for the rule.
ReferenceTable TagPipelineRulesetRuleReferenceTable: The reference table configuration for the rule.

enabled Boolean: Whether the rule is enabled.
name String: The name of the rule.
mapping TagPipelineRulesetRuleMapping: The mapping configuration for the rule.
metadata Map<String,String>: Rule metadata key-value pairs.
query TagPipelineRulesetRuleQuery: The query configuration for the rule.
referenceTable TagPipelineRulesetRuleReferenceTable: The reference table configuration for the rule.

enabled boolean: Whether the rule is enabled.
name string: The name of the rule.
mapping TagPipelineRulesetRuleMapping: The mapping configuration for the rule.
metadata {[key: string]: string}: Rule metadata key-value pairs.
query TagPipelineRulesetRuleQuery: The query configuration for the rule.
referenceTable TagPipelineRulesetRuleReferenceTable: The reference table configuration for the rule.

enabled bool: Whether the rule is enabled.
name str: The name of the rule.
mapping TagPipelineRulesetRuleMapping: The mapping configuration for the rule.
metadata Mapping[str, str]: Rule metadata key-value pairs.
query TagPipelineRulesetRuleQuery: The query configuration for the rule.
reference_table TagPipelineRulesetRuleReferenceTable: The reference table configuration for the rule.

enabled Boolean: Whether the rule is enabled.
name String: The name of the rule.
mapping Property Map: The mapping configuration for the rule.
metadata Map<String>: Rule metadata key-value pairs.
query Property Map: The query configuration for the rule.
referenceTable Property Map: The reference table configuration for the rule.

TagPipelineRulesetRuleMapping, TagPipelineRulesetRuleMappingArgs

DestinationKey string: The destination key for the mapping.
IfNotExists bool: Whether to apply the mapping only if the destination key doesn't exist.
SourceKeys List<string>: The source keys for the mapping.

DestinationKey string: The destination key for the mapping.
IfNotExists bool: Whether to apply the mapping only if the destination key doesn't exist.
SourceKeys []string: The source keys for the mapping.

destinationKey String: The destination key for the mapping.
ifNotExists Boolean: Whether to apply the mapping only if the destination key doesn't exist.
sourceKeys List<String>: The source keys for the mapping.

destinationKey string: The destination key for the mapping.
ifNotExists boolean: Whether to apply the mapping only if the destination key doesn't exist.
sourceKeys string[]: The source keys for the mapping.

destination_key str: The destination key for the mapping.
if_not_exists bool: Whether to apply the mapping only if the destination key doesn't exist.
source_keys Sequence[str]: The source keys for the mapping.

destinationKey String: The destination key for the mapping.
ifNotExists Boolean: Whether to apply the mapping only if the destination key doesn't exist.
sourceKeys List<String>: The source keys for the mapping.

TagPipelineRulesetRuleQuery, TagPipelineRulesetRuleQueryArgs

Addition TagPipelineRulesetRuleQueryAddition: The addition configuration for the query.
CaseInsensitivity bool: Whether the query matching is case insensitive.
IfNotExists bool: Whether to apply the query only if the key doesn't exist.
Query string: The query string.

Addition TagPipelineRulesetRuleQueryAddition: The addition configuration for the query.
CaseInsensitivity bool: Whether the query matching is case insensitive.
IfNotExists bool: Whether to apply the query only if the key doesn't exist.
Query string: The query string.

addition TagPipelineRulesetRuleQueryAddition: The addition configuration for the query.
caseInsensitivity Boolean: Whether the query matching is case insensitive.
ifNotExists Boolean: Whether to apply the query only if the key doesn't exist.
query String: The query string.

addition TagPipelineRulesetRuleQueryAddition: The addition configuration for the query.
caseInsensitivity boolean: Whether the query matching is case insensitive.
ifNotExists boolean: Whether to apply the query only if the key doesn't exist.
query string: The query string.

addition TagPipelineRulesetRuleQueryAddition: The addition configuration for the query.
case_insensitivity bool: Whether the query matching is case insensitive.
if_not_exists bool: Whether to apply the query only if the key doesn't exist.
query str: The query string.

addition Property Map: The addition configuration for the query.
caseInsensitivity Boolean: Whether the query matching is case insensitive.
ifNotExists Boolean: Whether to apply the query only if the key doesn't exist.
query String: The query string.

TagPipelineRulesetRuleQueryAddition, TagPipelineRulesetRuleQueryAdditionArgs

Key string: The key to add.
Value string: The value to add.

Key string: The key to add.
Value string: The value to add.

key String: The key to add.
value String: The value to add.

key string: The key to add.
value string: The value to add.

key str: The key to add.
value str: The value to add.

key String: The key to add.
value String: The value to add.

TagPipelineRulesetRuleReferenceTable, TagPipelineRulesetRuleReferenceTableArgs

CaseInsensitivity bool: Whether the reference table lookup is case insensitive.
FieldPairs List<TagPipelineRulesetRuleReferenceTableFieldPair>: The field pairs for the reference table.
IfNotExists bool: Whether to apply the reference table only if the key doesn't exist.
SourceKeys List<string>: The source keys for the reference table lookup.
TableName string: The name of the reference table.

CaseInsensitivity bool: Whether the reference table lookup is case insensitive.
FieldPairs []TagPipelineRulesetRuleReferenceTableFieldPair: The field pairs for the reference table.
IfNotExists bool: Whether to apply the reference table only if the key doesn't exist.
SourceKeys []string: The source keys for the reference table lookup.
TableName string: The name of the reference table.

caseInsensitivity Boolean: Whether the reference table lookup is case insensitive.
fieldPairs List<TagPipelineRulesetRuleReferenceTableFieldPair>: The field pairs for the reference table.
ifNotExists Boolean: Whether to apply the reference table only if the key doesn't exist.
sourceKeys List<String>: The source keys for the reference table lookup.
tableName String: The name of the reference table.

caseInsensitivity boolean: Whether the reference table lookup is case insensitive.
fieldPairs TagPipelineRulesetRuleReferenceTableFieldPair[]: The field pairs for the reference table.
ifNotExists boolean: Whether to apply the reference table only if the key doesn't exist.
sourceKeys string[]: The source keys for the reference table lookup.
tableName string: The name of the reference table.

case_insensitivity bool: Whether the reference table lookup is case insensitive.
field_pairs Sequence[TagPipelineRulesetRuleReferenceTableFieldPair]: The field pairs for the reference table.
if_not_exists bool: Whether to apply the reference table only if the key doesn't exist.
source_keys Sequence[str]: The source keys for the reference table lookup.
table_name str: The name of the reference table.

caseInsensitivity Boolean: Whether the reference table lookup is case insensitive.
fieldPairs List<Property Map>: The field pairs for the reference table.
ifNotExists Boolean: Whether to apply the reference table only if the key doesn't exist.
sourceKeys List<String>: The source keys for the reference table lookup.
tableName String: The name of the reference table.

TagPipelineRulesetRuleReferenceTableFieldPair, TagPipelineRulesetRuleReferenceTableFieldPairArgs

InputColumn string: The input column name.
OutputKey string: The output key name.

InputColumn string: The input column name.
OutputKey string: The output key name.

inputColumn String: The input column name.
outputKey String: The output key name.

inputColumn string: The input column name.
outputKey string: The output key name.

input_column str: The input column name.
output_key str: The output key name.

inputColumn String: The input column name.
outputKey String: The output key name.

Import

The pulumi import command can be used, for example:

$ pulumi import datadog:index/tagPipelineRuleset:TagPipelineRuleset example "your-ruleset-id-here"

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 v4.58.0 published on Thursday, Oct 16, 2025 by Pulumi

pulumi/pulumi-datadog

datadog.TagPipelineRuleset

On this page

On this page

Example Usage

Create TagPipelineRuleset Resource

Constructor syntax

Parameters

Constructor example

TagPipelineRuleset Resource Properties

Inputs

Outputs

Look up Existing TagPipelineRuleset Resource

Supporting Types

TagPipelineRulesetRule, TagPipelineRulesetRuleArgs

TagPipelineRulesetRuleMapping, TagPipelineRulesetRuleMappingArgs

TagPipelineRulesetRuleQuery, TagPipelineRulesetRuleQueryArgs

TagPipelineRulesetRuleQueryAddition, TagPipelineRulesetRuleQueryAdditionArgs

TagPipelineRulesetRuleReferenceTable, TagPipelineRulesetRuleReferenceTableArgs

TagPipelineRulesetRuleReferenceTableFieldPair, TagPipelineRulesetRuleReferenceTableFieldPairArgs

Import

Package Details

On this page

On this page