datadog.MetricTagConfiguration
Explore with Pulumi AI
Provides a Datadog metric tag configuration resource. This can be used to modify tag configurations for metrics.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";
// Manage a tag configuration for a Datadog distribution metric with/without percentiles
const exampleDistMetric = new datadog.MetricTagConfiguration("example_dist_metric", {
metricName: "example.terraform.dist.metric",
metricType: "distribution",
tags: [
"sport",
"datacenter",
],
includePercentiles: false,
});
// Manage tag configurations for a Datadog count or gauge metric
const exampleCountMetric = new datadog.MetricTagConfiguration("example_count_metric", {
metricName: "example.terraform.count.metric",
metricType: "count",
tags: [
"sport",
"datacenter",
],
excludeTagsMode: false,
aggregations: [
{
time: "avg",
space: "min",
},
{
time: "avg",
space: "max",
},
],
});
import pulumi
import pulumi_datadog as datadog
# Manage a tag configuration for a Datadog distribution metric with/without percentiles
example_dist_metric = datadog.MetricTagConfiguration("example_dist_metric",
metric_name="example.terraform.dist.metric",
metric_type="distribution",
tags=[
"sport",
"datacenter",
],
include_percentiles=False)
# Manage tag configurations for a Datadog count or gauge metric
example_count_metric = datadog.MetricTagConfiguration("example_count_metric",
metric_name="example.terraform.count.metric",
metric_type="count",
tags=[
"sport",
"datacenter",
],
exclude_tags_mode=False,
aggregations=[
{
"time": "avg",
"space": "min",
},
{
"time": "avg",
"space": "max",
},
])
package main
import (
"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Manage a tag configuration for a Datadog distribution metric with/without percentiles
_, err := datadog.NewMetricTagConfiguration(ctx, "example_dist_metric", &datadog.MetricTagConfigurationArgs{
MetricName: pulumi.String("example.terraform.dist.metric"),
MetricType: pulumi.String("distribution"),
Tags: pulumi.StringArray{
pulumi.String("sport"),
pulumi.String("datacenter"),
},
IncludePercentiles: pulumi.Bool(false),
})
if err != nil {
return err
}
// Manage tag configurations for a Datadog count or gauge metric
_, err = datadog.NewMetricTagConfiguration(ctx, "example_count_metric", &datadog.MetricTagConfigurationArgs{
MetricName: pulumi.String("example.terraform.count.metric"),
MetricType: pulumi.String("count"),
Tags: pulumi.StringArray{
pulumi.String("sport"),
pulumi.String("datacenter"),
},
ExcludeTagsMode: pulumi.Bool(false),
Aggregations: datadog.MetricTagConfigurationAggregationArray{
&datadog.MetricTagConfigurationAggregationArgs{
Time: pulumi.String("avg"),
Space: pulumi.String("min"),
},
&datadog.MetricTagConfigurationAggregationArgs{
Time: pulumi.String("avg"),
Space: pulumi.String("max"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;
return await Deployment.RunAsync(() =>
{
// Manage a tag configuration for a Datadog distribution metric with/without percentiles
var exampleDistMetric = new Datadog.MetricTagConfiguration("example_dist_metric", new()
{
MetricName = "example.terraform.dist.metric",
MetricType = "distribution",
Tags = new[]
{
"sport",
"datacenter",
},
IncludePercentiles = false,
});
// Manage tag configurations for a Datadog count or gauge metric
var exampleCountMetric = new Datadog.MetricTagConfiguration("example_count_metric", new()
{
MetricName = "example.terraform.count.metric",
MetricType = "count",
Tags = new[]
{
"sport",
"datacenter",
},
ExcludeTagsMode = false,
Aggregations = new[]
{
new Datadog.Inputs.MetricTagConfigurationAggregationArgs
{
Time = "avg",
Space = "min",
},
new Datadog.Inputs.MetricTagConfigurationAggregationArgs
{
Time = "avg",
Space = "max",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.MetricTagConfiguration;
import com.pulumi.datadog.MetricTagConfigurationArgs;
import com.pulumi.datadog.inputs.MetricTagConfigurationAggregationArgs;
import java.util.List;
import java.util.ArrayList;
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) {
// Manage a tag configuration for a Datadog distribution metric with/without percentiles
var exampleDistMetric = new MetricTagConfiguration("exampleDistMetric", MetricTagConfigurationArgs.builder()
.metricName("example.terraform.dist.metric")
.metricType("distribution")
.tags(
"sport",
"datacenter")
.includePercentiles(false)
.build());
// Manage tag configurations for a Datadog count or gauge metric
var exampleCountMetric = new MetricTagConfiguration("exampleCountMetric", MetricTagConfigurationArgs.builder()
.metricName("example.terraform.count.metric")
.metricType("count")
.tags(
"sport",
"datacenter")
.excludeTagsMode(false)
.aggregations(
MetricTagConfigurationAggregationArgs.builder()
.time("avg")
.space("min")
.build(),
MetricTagConfigurationAggregationArgs.builder()
.time("avg")
.space("max")
.build())
.build());
}
}
resources:
# Manage a tag configuration for a Datadog distribution metric with/without percentiles
exampleDistMetric:
type: datadog:MetricTagConfiguration
name: example_dist_metric
properties:
metricName: example.terraform.dist.metric
metricType: distribution
tags:
- sport
- datacenter
includePercentiles: false
# Manage tag configurations for a Datadog count or gauge metric
exampleCountMetric:
type: datadog:MetricTagConfiguration
name: example_count_metric
properties:
metricName: example.terraform.count.metric
metricType: count
tags:
- sport
- datacenter
excludeTagsMode: false
aggregations:
- time: avg
space: min
- time: avg
space: max
Create MetricTagConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new MetricTagConfiguration(name: string, args: MetricTagConfigurationArgs, opts?: CustomResourceOptions);
@overload
def MetricTagConfiguration(resource_name: str,
args: MetricTagConfigurationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def MetricTagConfiguration(resource_name: str,
opts: Optional[ResourceOptions] = None,
metric_name: Optional[str] = None,
metric_type: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
aggregations: Optional[Sequence[MetricTagConfigurationAggregationArgs]] = None,
exclude_tags_mode: Optional[bool] = None,
include_percentiles: Optional[bool] = None)
func NewMetricTagConfiguration(ctx *Context, name string, args MetricTagConfigurationArgs, opts ...ResourceOption) (*MetricTagConfiguration, error)
public MetricTagConfiguration(string name, MetricTagConfigurationArgs args, CustomResourceOptions? opts = null)
public MetricTagConfiguration(String name, MetricTagConfigurationArgs args)
public MetricTagConfiguration(String name, MetricTagConfigurationArgs args, CustomResourceOptions options)
type: datadog:MetricTagConfiguration
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 MetricTagConfigurationArgs
- 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 MetricTagConfigurationArgs
- 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 MetricTagConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MetricTagConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args MetricTagConfigurationArgs
- 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 metricTagConfigurationResource = new Datadog.MetricTagConfiguration("metricTagConfigurationResource", new()
{
MetricName = "string",
MetricType = "string",
Tags = new[]
{
"string",
},
Aggregations = new[]
{
new Datadog.Inputs.MetricTagConfigurationAggregationArgs
{
Space = "string",
Time = "string",
},
},
ExcludeTagsMode = false,
IncludePercentiles = false,
});
example, err := datadog.NewMetricTagConfiguration(ctx, "metricTagConfigurationResource", &datadog.MetricTagConfigurationArgs{
MetricName: pulumi.String("string"),
MetricType: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Aggregations: datadog.MetricTagConfigurationAggregationArray{
&datadog.MetricTagConfigurationAggregationArgs{
Space: pulumi.String("string"),
Time: pulumi.String("string"),
},
},
ExcludeTagsMode: pulumi.Bool(false),
IncludePercentiles: pulumi.Bool(false),
})
var metricTagConfigurationResource = new MetricTagConfiguration("metricTagConfigurationResource", MetricTagConfigurationArgs.builder()
.metricName("string")
.metricType("string")
.tags("string")
.aggregations(MetricTagConfigurationAggregationArgs.builder()
.space("string")
.time("string")
.build())
.excludeTagsMode(false)
.includePercentiles(false)
.build());
metric_tag_configuration_resource = datadog.MetricTagConfiguration("metricTagConfigurationResource",
metric_name="string",
metric_type="string",
tags=["string"],
aggregations=[{
"space": "string",
"time": "string",
}],
exclude_tags_mode=False,
include_percentiles=False)
const metricTagConfigurationResource = new datadog.MetricTagConfiguration("metricTagConfigurationResource", {
metricName: "string",
metricType: "string",
tags: ["string"],
aggregations: [{
space: "string",
time: "string",
}],
excludeTagsMode: false,
includePercentiles: false,
});
type: datadog:MetricTagConfiguration
properties:
aggregations:
- space: string
time: string
excludeTagsMode: false
includePercentiles: false
metricName: string
metricType: string
tags:
- string
MetricTagConfiguration 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 MetricTagConfiguration resource accepts the following input properties:
- Metric
Name string - The metric name for this resource.
- Metric
Type string - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - List<string>
- A list of tag keys that will be queryable for your metric.
- Aggregations
List<Metric
Tag Configuration Aggregation> - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - bool
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - Include
Percentiles bool - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution.
- Metric
Name string - The metric name for this resource.
- Metric
Type string - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - []string
- A list of tag keys that will be queryable for your metric.
- Aggregations
[]Metric
Tag Configuration Aggregation Args - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - bool
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - Include
Percentiles bool - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution.
- metric
Name String - The metric name for this resource.
- metric
Type String - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - List<String>
- A list of tag keys that will be queryable for your metric.
- aggregations
List<Metric
Tag Configuration Aggregation> - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - Boolean
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - include
Percentiles Boolean - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution.
- metric
Name string - The metric name for this resource.
- metric
Type string - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - string[]
- A list of tag keys that will be queryable for your metric.
- aggregations
Metric
Tag Configuration Aggregation[] - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - boolean
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - include
Percentiles boolean - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution.
- metric_
name str - The metric name for this resource.
- metric_
type str - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - Sequence[str]
- A list of tag keys that will be queryable for your metric.
- aggregations
Sequence[Metric
Tag Configuration Aggregation Args] - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - bool
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - include_
percentiles bool - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution.
- metric
Name String - The metric name for this resource.
- metric
Type String - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - List<String>
- A list of tag keys that will be queryable for your metric.
- aggregations List<Property Map>
- A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - Boolean
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - include
Percentiles Boolean - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution.
Outputs
All input properties are implicitly available as output properties. Additionally, the MetricTagConfiguration 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 MetricTagConfiguration Resource
Get an existing MetricTagConfiguration 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?: MetricTagConfigurationState, opts?: CustomResourceOptions): MetricTagConfiguration
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aggregations: Optional[Sequence[MetricTagConfigurationAggregationArgs]] = None,
exclude_tags_mode: Optional[bool] = None,
include_percentiles: Optional[bool] = None,
metric_name: Optional[str] = None,
metric_type: Optional[str] = None,
tags: Optional[Sequence[str]] = None) -> MetricTagConfiguration
func GetMetricTagConfiguration(ctx *Context, name string, id IDInput, state *MetricTagConfigurationState, opts ...ResourceOption) (*MetricTagConfiguration, error)
public static MetricTagConfiguration Get(string name, Input<string> id, MetricTagConfigurationState? state, CustomResourceOptions? opts = null)
public static MetricTagConfiguration get(String name, Output<String> id, MetricTagConfigurationState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Aggregations
List<Metric
Tag Configuration Aggregation> - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - bool
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - Include
Percentiles bool - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution. - Metric
Name string - The metric name for this resource.
- Metric
Type string - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - List<string>
- A list of tag keys that will be queryable for your metric.
- Aggregations
[]Metric
Tag Configuration Aggregation Args - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - bool
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - Include
Percentiles bool - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution. - Metric
Name string - The metric name for this resource.
- Metric
Type string - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - []string
- A list of tag keys that will be queryable for your metric.
- aggregations
List<Metric
Tag Configuration Aggregation> - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - Boolean
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - include
Percentiles Boolean - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution. - metric
Name String - The metric name for this resource.
- metric
Type String - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - List<String>
- A list of tag keys that will be queryable for your metric.
- aggregations
Metric
Tag Configuration Aggregation[] - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - boolean
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - include
Percentiles boolean - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution. - metric
Name string - The metric name for this resource.
- metric
Type string - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - string[]
- A list of tag keys that will be queryable for your metric.
- aggregations
Sequence[Metric
Tag Configuration Aggregation Args] - A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - bool
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - include_
percentiles bool - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution. - metric_
name str - The metric name for this resource.
- metric_
type str - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - Sequence[str]
- A list of tag keys that will be queryable for your metric.
- aggregations List<Property Map>
- A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and gauge metrics require the (time: avg, space: avg) aggregation. Can only be applied to metrics that have a
metric_type
of count, rate, or gauge. - Boolean
- Toggle to include/exclude tags as queryable for your metric. Can only be applied to metrics that have one or more tags configured. Defaults to
false
. - include
Percentiles Boolean - Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a
metric_type
of distribution. - metric
Name String - The metric name for this resource.
- metric
Type String - The metric's type. This field can't be updated after creation. Valid values are
gauge
,count
,rate
,distribution
. - List<String>
- A list of tag keys that will be queryable for your metric.
Supporting Types
MetricTagConfigurationAggregation, MetricTagConfigurationAggregationArgs
Import
$ pulumi import datadog:index/metricTagConfiguration:MetricTagConfiguration example_dist_metric example.terraform.dist.metric
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.