Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Signalfx Provider
  3. API Docs
  4. MetricRuleset
SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-signalfx

signalfx.MetricRuleset

Explore with Pulumi AI

signalfx logo
SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-signalfx

    Provides an Observability Cloud resource for managing metric rulesets.

    NOTE When managing metric rulesets to drop data use a session token for an administrator to authenticate the Splunk Observability Cloud provider. See Operations that require a session token for an administrator. Otherwise you’ll receive a 4xx error.

    Example

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

const cpuUtilizationMetricRuleset = new signalfx.MetricRuleset("cpu_utilization_metric_ruleset", {
    metricName: "cpu.utilization",
    description: "Routing ruleset for cpu.utilization",
    aggregationRules: [{
        name: "cpu.utilization by service rule",
        description: "Aggregates cpu.utilization data by service",
        enabled: true,
        matchers: [{
            type: "dimension",
            filters: [{
                property: "realm",
                propertyValues: ["us-east-1"],
                not: false,
            }],
        }],
        aggregators: [{
            type: "rollup",
            dimensions: ["service"],
            dropDimensions: false,
            outputName: "cpu.utilization.by.service.agg",
        }],
    }],
    exceptionRules: [{
        name: "Exception rule us-east-2",
        description: "Routes us-east-2 data to real-time",
        enabled: true,
        matchers: [{
            type: "dimension",
            filters: [{
                property: "realm",
                propertyValues: ["us-east-2"],
                not: false,
            }],
        }],
    }],
    routingRules: [{
        destination: "Archived",
    }],
});

    import pulumi
import pulumi_signalfx as signalfx

cpu_utilization_metric_ruleset = signalfx.MetricRuleset("cpu_utilization_metric_ruleset",
    metric_name="cpu.utilization",
    description="Routing ruleset for cpu.utilization",
    aggregation_rules=[{
        "name": "cpu.utilization by service rule",
        "description": "Aggregates cpu.utilization data by service",
        "enabled": True,
        "matchers": [{
            "type": "dimension",
            "filters": [{
                "property": "realm",
                "property_values": ["us-east-1"],
                "not_": False,
            }],
        }],
        "aggregators": [{
            "type": "rollup",
            "dimensions": ["service"],
            "drop_dimensions": False,
            "output_name": "cpu.utilization.by.service.agg",
        }],
    }],
    exception_rules=[{
        "name": "Exception rule us-east-2",
        "description": "Routes us-east-2 data to real-time",
        "enabled": True,
        "matchers": [{
            "type": "dimension",
            "filters": [{
                "property": "realm",
                "property_values": ["us-east-2"],
                "not_": False,
            }],
        }],
    }],
    routing_rules=[{
        "destination": "Archived",
    }])

    package main

import (
	"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := signalfx.NewMetricRuleset(ctx, "cpu_utilization_metric_ruleset", &signalfx.MetricRulesetArgs{
			MetricName:  pulumi.String("cpu.utilization"),
			Description: pulumi.String("Routing ruleset for cpu.utilization"),
			AggregationRules: signalfx.MetricRulesetAggregationRuleArray{
				&signalfx.MetricRulesetAggregationRuleArgs{
					Name:        pulumi.String("cpu.utilization by service rule"),
					Description: pulumi.String("Aggregates cpu.utilization data by service"),
					Enabled:     pulumi.Bool(true),
					Matchers: signalfx.MetricRulesetAggregationRuleMatcherArray{
						&signalfx.MetricRulesetAggregationRuleMatcherArgs{
							Type: pulumi.String("dimension"),
							Filters: signalfx.MetricRulesetAggregationRuleMatcherFilterArray{
								&signalfx.MetricRulesetAggregationRuleMatcherFilterArgs{
									Property: pulumi.String("realm"),
									PropertyValues: pulumi.StringArray{
										pulumi.String("us-east-1"),
									},
									Not: pulumi.Bool(false),
								},
							},
						},
					},
					Aggregators: signalfx.MetricRulesetAggregationRuleAggregatorArray{
						&signalfx.MetricRulesetAggregationRuleAggregatorArgs{
							Type: pulumi.String("rollup"),
							Dimensions: pulumi.StringArray{
								pulumi.String("service"),
							},
							DropDimensions: pulumi.Bool(false),
							OutputName:     pulumi.String("cpu.utilization.by.service.agg"),
						},
					},
				},
			},
			ExceptionRules: signalfx.MetricRulesetExceptionRuleArray{
				&signalfx.MetricRulesetExceptionRuleArgs{
					Name:        pulumi.String("Exception rule us-east-2"),
					Description: pulumi.String("Routes us-east-2 data to real-time"),
					Enabled:     pulumi.Bool(true),
					Matchers: signalfx.MetricRulesetExceptionRuleMatcherArray{
						&signalfx.MetricRulesetExceptionRuleMatcherArgs{
							Type: pulumi.String("dimension"),
							Filters: signalfx.MetricRulesetExceptionRuleMatcherFilterArray{
								&signalfx.MetricRulesetExceptionRuleMatcherFilterArgs{
									Property: pulumi.String("realm"),
									PropertyValues: pulumi.StringArray{
										pulumi.String("us-east-2"),
									},
									Not: pulumi.Bool(false),
								},
							},
						},
					},
				},
			},
			RoutingRules: signalfx.MetricRulesetRoutingRuleArray{
				&signalfx.MetricRulesetRoutingRuleArgs{
					Destination: pulumi.String("Archived"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var cpuUtilizationMetricRuleset = new SignalFx.MetricRuleset("cpu_utilization_metric_ruleset", new()
    {
        MetricName = "cpu.utilization",
        Description = "Routing ruleset for cpu.utilization",
        AggregationRules = new[]
        {
            new SignalFx.Inputs.MetricRulesetAggregationRuleArgs
            {
                Name = "cpu.utilization by service rule",
                Description = "Aggregates cpu.utilization data by service",
                Enabled = true,
                Matchers = new[]
                {
                    new SignalFx.Inputs.MetricRulesetAggregationRuleMatcherArgs
                    {
                        Type = "dimension",
                        Filters = new[]
                        {
                            new SignalFx.Inputs.MetricRulesetAggregationRuleMatcherFilterArgs
                            {
                                Property = "realm",
                                PropertyValues = new[]
                                {
                                    "us-east-1",
                                },
                                Not = false,
                            },
                        },
                    },
                },
                Aggregators = new[]
                {
                    new SignalFx.Inputs.MetricRulesetAggregationRuleAggregatorArgs
                    {
                        Type = "rollup",
                        Dimensions = new[]
                        {
                            "service",
                        },
                        DropDimensions = false,
                        OutputName = "cpu.utilization.by.service.agg",
                    },
                },
            },
        },
        ExceptionRules = new[]
        {
            new SignalFx.Inputs.MetricRulesetExceptionRuleArgs
            {
                Name = "Exception rule us-east-2",
                Description = "Routes us-east-2 data to real-time",
                Enabled = true,
                Matchers = new[]
                {
                    new SignalFx.Inputs.MetricRulesetExceptionRuleMatcherArgs
                    {
                        Type = "dimension",
                        Filters = new[]
                        {
                            new SignalFx.Inputs.MetricRulesetExceptionRuleMatcherFilterArgs
                            {
                                Property = "realm",
                                PropertyValues = new[]
                                {
                                    "us-east-2",
                                },
                                Not = false,
                            },
                        },
                    },
                },
            },
        },
        RoutingRules = new[]
        {
            new SignalFx.Inputs.MetricRulesetRoutingRuleArgs
            {
                Destination = "Archived",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.MetricRuleset;
import com.pulumi.signalfx.MetricRulesetArgs;
import com.pulumi.signalfx.inputs.MetricRulesetAggregationRuleArgs;
import com.pulumi.signalfx.inputs.MetricRulesetExceptionRuleArgs;
import com.pulumi.signalfx.inputs.MetricRulesetRoutingRuleArgs;
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) {
        var cpuUtilizationMetricRuleset = new MetricRuleset("cpuUtilizationMetricRuleset", MetricRulesetArgs.builder()
            .metricName("cpu.utilization")
            .description("Routing ruleset for cpu.utilization")
            .aggregationRules(MetricRulesetAggregationRuleArgs.builder()
                .name("cpu.utilization by service rule")
                .description("Aggregates cpu.utilization data by service")
                .enabled(true)
                .matchers(MetricRulesetAggregationRuleMatcherArgs.builder()
                    .type("dimension")
                    .filters(MetricRulesetAggregationRuleMatcherFilterArgs.builder()
                        .property("realm")
                        .propertyValues("us-east-1")
                        .not(false)
                        .build())
                    .build())
                .aggregators(MetricRulesetAggregationRuleAggregatorArgs.builder()
                    .type("rollup")
                    .dimensions("service")
                    .dropDimensions(false)
                    .outputName("cpu.utilization.by.service.agg")
                    .build())
                .build())
            .exceptionRules(MetricRulesetExceptionRuleArgs.builder()
                .name("Exception rule us-east-2")
                .description("Routes us-east-2 data to real-time")
                .enabled(true)
                .matchers(MetricRulesetExceptionRuleMatcherArgs.builder()
                    .type("dimension")
                    .filters(MetricRulesetExceptionRuleMatcherFilterArgs.builder()
                        .property("realm")
                        .propertyValues("us-east-2")
                        .not(false)
                        .build())
                    .build())
                .build())
            .routingRules(MetricRulesetRoutingRuleArgs.builder()
                .destination("Archived")
                .build())
            .build());

    }
}

    resources:
  cpuUtilizationMetricRuleset:
    type: signalfx:MetricRuleset
    name: cpu_utilization_metric_ruleset
    properties:
      metricName: cpu.utilization
      description: Routing ruleset for cpu.utilization
      aggregationRules:
        - name: cpu.utilization by service rule
          description: Aggregates cpu.utilization data by service
          enabled: true
          matchers:
            - type: dimension
              filters:
                - property: realm
                  propertyValues:
                    - us-east-1
                  not: false
          aggregators:
            - type: rollup
              dimensions:
                - service
              dropDimensions: false
              outputName: cpu.utilization.by.service.agg
      exceptionRules:
        - name: Exception rule us-east-2
          description: Routes us-east-2 data to real-time
          enabled: true
          matchers:
            - type: dimension
              filters:
                - property: realm
                  propertyValues:
                    - us-east-2
                  not: false
      routingRules:
        - destination: Archived

    Create MetricRuleset Resource

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

    Constructor syntax

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

@overload
def MetricRuleset(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  metric_name: Optional[str] = None,
                  routing_rules: Optional[Sequence[MetricRulesetRoutingRuleArgs]] = None,
                  aggregation_rules: Optional[Sequence[MetricRulesetAggregationRuleArgs]] = None,
                  description: Optional[str] = None,
                  exception_rules: Optional[Sequence[MetricRulesetExceptionRuleArgs]] = None)
    func NewMetricRuleset(ctx *Context, name string, args MetricRulesetArgs, opts ...ResourceOption) (*MetricRuleset, error)
    public MetricRuleset(string name, MetricRulesetArgs args, CustomResourceOptions? opts = null)
    public MetricRuleset(String name, MetricRulesetArgs args)
public MetricRuleset(String name, MetricRulesetArgs args, CustomResourceOptions options)

    type: signalfx:MetricRuleset
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 MetricRulesetArgs
    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 MetricRulesetArgs
    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 MetricRulesetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetricRulesetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetricRulesetArgs
    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 metricRulesetResource = new SignalFx.MetricRuleset("metricRulesetResource", new()
{
    MetricName = "string",
    RoutingRules = new[]
    {
        new SignalFx.Inputs.MetricRulesetRoutingRuleArgs
        {
            Destination = "string",
        },
    },
    AggregationRules = new[]
    {
        new SignalFx.Inputs.MetricRulesetAggregationRuleArgs
        {
            Aggregators = new[]
            {
                new SignalFx.Inputs.MetricRulesetAggregationRuleAggregatorArgs
                {
                    Dimensions = new[]
                    {
                        "string",
                    },
                    DropDimensions = false,
                    OutputName = "string",
                    Type = "string",
                },
            },
            Enabled = false,
            Matchers = new[]
            {
                new SignalFx.Inputs.MetricRulesetAggregationRuleMatcherArgs
                {
                    Type = "string",
                    Filters = new[]
                    {
                        new SignalFx.Inputs.MetricRulesetAggregationRuleMatcherFilterArgs
                        {
                            Not = false,
                            Property = "string",
                            PropertyValues = new[]
                            {
                                "string",
                            },
                        },
                    },
                },
            },
            Description = "string",
            Name = "string",
        },
    },
    Description = "string",
    ExceptionRules = new[]
    {
        new SignalFx.Inputs.MetricRulesetExceptionRuleArgs
        {
            Enabled = false,
            Matchers = new[]
            {
                new SignalFx.Inputs.MetricRulesetExceptionRuleMatcherArgs
                {
                    Type = "string",
                    Filters = new[]
                    {
                        new SignalFx.Inputs.MetricRulesetExceptionRuleMatcherFilterArgs
                        {
                            Not = false,
                            Property = "string",
                            PropertyValues = new[]
                            {
                                "string",
                            },
                        },
                    },
                },
            },
            Description = "string",
            Name = "string",
            Restorations = new[]
            {
                new SignalFx.Inputs.MetricRulesetExceptionRuleRestorationArgs
                {
                    StartTime = "string",
                    RestorationId = "string",
                    StopTime = "string",
                },
            },
        },
    },
});

    example, err := signalfx.NewMetricRuleset(ctx, "metricRulesetResource", &signalfx.MetricRulesetArgs{
	MetricName: pulumi.String("string"),
	RoutingRules: signalfx.MetricRulesetRoutingRuleArray{
		&signalfx.MetricRulesetRoutingRuleArgs{
			Destination: pulumi.String("string"),
		},
	},
	AggregationRules: signalfx.MetricRulesetAggregationRuleArray{
		&signalfx.MetricRulesetAggregationRuleArgs{
			Aggregators: signalfx.MetricRulesetAggregationRuleAggregatorArray{
				&signalfx.MetricRulesetAggregationRuleAggregatorArgs{
					Dimensions: pulumi.StringArray{
						pulumi.String("string"),
					},
					DropDimensions: pulumi.Bool(false),
					OutputName:     pulumi.String("string"),
					Type:           pulumi.String("string"),
				},
			},
			Enabled: pulumi.Bool(false),
			Matchers: signalfx.MetricRulesetAggregationRuleMatcherArray{
				&signalfx.MetricRulesetAggregationRuleMatcherArgs{
					Type: pulumi.String("string"),
					Filters: signalfx.MetricRulesetAggregationRuleMatcherFilterArray{
						&signalfx.MetricRulesetAggregationRuleMatcherFilterArgs{
							Not:      pulumi.Bool(false),
							Property: pulumi.String("string"),
							PropertyValues: pulumi.StringArray{
								pulumi.String("string"),
							},
						},
					},
				},
			},
			Description: pulumi.String("string"),
			Name:        pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	ExceptionRules: signalfx.MetricRulesetExceptionRuleArray{
		&signalfx.MetricRulesetExceptionRuleArgs{
			Enabled: pulumi.Bool(false),
			Matchers: signalfx.MetricRulesetExceptionRuleMatcherArray{
				&signalfx.MetricRulesetExceptionRuleMatcherArgs{
					Type: pulumi.String("string"),
					Filters: signalfx.MetricRulesetExceptionRuleMatcherFilterArray{
						&signalfx.MetricRulesetExceptionRuleMatcherFilterArgs{
							Not:      pulumi.Bool(false),
							Property: pulumi.String("string"),
							PropertyValues: pulumi.StringArray{
								pulumi.String("string"),
							},
						},
					},
				},
			},
			Description: pulumi.String("string"),
			Name:        pulumi.String("string"),
			Restorations: signalfx.MetricRulesetExceptionRuleRestorationArray{
				&signalfx.MetricRulesetExceptionRuleRestorationArgs{
					StartTime:     pulumi.String("string"),
					RestorationId: pulumi.String("string"),
					StopTime:      pulumi.String("string"),
				},
			},
		},
	},
})

    var metricRulesetResource = new MetricRuleset("metricRulesetResource", MetricRulesetArgs.builder()
    .metricName("string")
    .routingRules(MetricRulesetRoutingRuleArgs.builder()
        .destination("string")
        .build())
    .aggregationRules(MetricRulesetAggregationRuleArgs.builder()
        .aggregators(MetricRulesetAggregationRuleAggregatorArgs.builder()
            .dimensions("string")
            .dropDimensions(false)
            .outputName("string")
            .type("string")
            .build())
        .enabled(false)
        .matchers(MetricRulesetAggregationRuleMatcherArgs.builder()
            .type("string")
            .filters(MetricRulesetAggregationRuleMatcherFilterArgs.builder()
                .not(false)
                .property("string")
                .propertyValues("string")
                .build())
            .build())
        .description("string")
        .name("string")
        .build())
    .description("string")
    .exceptionRules(MetricRulesetExceptionRuleArgs.builder()
        .enabled(false)
        .matchers(MetricRulesetExceptionRuleMatcherArgs.builder()
            .type("string")
            .filters(MetricRulesetExceptionRuleMatcherFilterArgs.builder()
                .not(false)
                .property("string")
                .propertyValues("string")
                .build())
            .build())
        .description("string")
        .name("string")
        .restorations(MetricRulesetExceptionRuleRestorationArgs.builder()
            .startTime("string")
            .restorationId("string")
            .stopTime("string")
            .build())
        .build())
    .build());

    metric_ruleset_resource = signalfx.MetricRuleset("metricRulesetResource",
    metric_name="string",
    routing_rules=[{
        "destination": "string",
    }],
    aggregation_rules=[{
        "aggregators": [{
            "dimensions": ["string"],
            "drop_dimensions": False,
            "output_name": "string",
            "type": "string",
        }],
        "enabled": False,
        "matchers": [{
            "type": "string",
            "filters": [{
                "not_": False,
                "property": "string",
                "property_values": ["string"],
            }],
        }],
        "description": "string",
        "name": "string",
    }],
    description="string",
    exception_rules=[{
        "enabled": False,
        "matchers": [{
            "type": "string",
            "filters": [{
                "not_": False,
                "property": "string",
                "property_values": ["string"],
            }],
        }],
        "description": "string",
        "name": "string",
        "restorations": [{
            "start_time": "string",
            "restoration_id": "string",
            "stop_time": "string",
        }],
    }])

    const metricRulesetResource = new signalfx.MetricRuleset("metricRulesetResource", {
    metricName: "string",
    routingRules: [{
        destination: "string",
    }],
    aggregationRules: [{
        aggregators: [{
            dimensions: ["string"],
            dropDimensions: false,
            outputName: "string",
            type: "string",
        }],
        enabled: false,
        matchers: [{
            type: "string",
            filters: [{
                not: false,
                property: "string",
                propertyValues: ["string"],
            }],
        }],
        description: "string",
        name: "string",
    }],
    description: "string",
    exceptionRules: [{
        enabled: false,
        matchers: [{
            type: "string",
            filters: [{
                not: false,
                property: "string",
                propertyValues: ["string"],
            }],
        }],
        description: "string",
        name: "string",
        restorations: [{
            startTime: "string",
            restorationId: "string",
            stopTime: "string",
        }],
    }],
});

    type: signalfx:MetricRuleset
properties:
    aggregationRules:
        - aggregators:
            - dimensions:
                - string
              dropDimensions: false
              outputName: string
              type: string
          description: string
          enabled: false
          matchers:
            - filters:
                - not: false
                  property: string
                  propertyValues:
                    - string
              type: string
          name: string
    description: string
    exceptionRules:
        - description: string
          enabled: false
          matchers:
            - filters:
                - not: false
                  property: string
                  propertyValues:
                    - string
              type: string
          name: string
          restorations:
            - restorationId: string
              startTime: string
              stopTime: string
    metricName: string
    routingRules:
        - destination: string

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

    MetricName string
    Name of the input metric
    RoutingRules List<Pulumi.SignalFx.Inputs.MetricRulesetRoutingRule>
    Routing Rule object
    AggregationRules List<Pulumi.SignalFx.Inputs.MetricRulesetAggregationRule>
    List of aggregation rules for the metric
    Description string
    Information about the metric ruleset
    ExceptionRules List<Pulumi.SignalFx.Inputs.MetricRulesetExceptionRule>
    List of exception rules for the metric
    MetricName string
    Name of the input metric
    RoutingRules []MetricRulesetRoutingRuleArgs
    Routing Rule object
    AggregationRules []MetricRulesetAggregationRuleArgs
    List of aggregation rules for the metric
    Description string
    Information about the metric ruleset
    ExceptionRules []MetricRulesetExceptionRuleArgs
    List of exception rules for the metric
    metricName String
    Name of the input metric
    routingRules List<MetricRulesetRoutingRule>
    Routing Rule object
    aggregationRules List<MetricRulesetAggregationRule>
    List of aggregation rules for the metric
    description String
    Information about the metric ruleset
    exceptionRules List<MetricRulesetExceptionRule>
    List of exception rules for the metric
    metricName string
    Name of the input metric
    routingRules MetricRulesetRoutingRule[]
    Routing Rule object
    aggregationRules MetricRulesetAggregationRule[]
    List of aggregation rules for the metric
    description string
    Information about the metric ruleset
    exceptionRules MetricRulesetExceptionRule[]
    List of exception rules for the metric
    metric_name str
    Name of the input metric
    routing_rules Sequence[MetricRulesetRoutingRuleArgs]
    Routing Rule object
    aggregation_rules Sequence[MetricRulesetAggregationRuleArgs]
    List of aggregation rules for the metric
    description str
    Information about the metric ruleset
    exception_rules Sequence[MetricRulesetExceptionRuleArgs]
    List of exception rules for the metric
    metricName String
    Name of the input metric
    routingRules List<Property Map>
    Routing Rule object
    aggregationRules List<Property Map>
    List of aggregation rules for the metric
    description String
    Information about the metric ruleset
    exceptionRules List<Property Map>
    List of exception rules for the metric

    Outputs

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

    Created string
    Timestamp of when the metric ruleset was created
    Creator string
    ID of the creator of the metric ruleset
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Timestamp of when the metric ruleset was last updated
    LastUpdatedBy string
    ID of user who last updated the metric ruleset
    LastUpdatedByName string
    Name of user who last updated this metric ruleset
    Version string
    Version of the ruleset
    Created string
    Timestamp of when the metric ruleset was created
    Creator string
    ID of the creator of the metric ruleset
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Timestamp of when the metric ruleset was last updated
    LastUpdatedBy string
    ID of user who last updated the metric ruleset
    LastUpdatedByName string
    Name of user who last updated this metric ruleset
    Version string
    Version of the ruleset
    created String
    Timestamp of when the metric ruleset was created
    creator String
    ID of the creator of the metric ruleset
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    Timestamp of when the metric ruleset was last updated
    lastUpdatedBy String
    ID of user who last updated the metric ruleset
    lastUpdatedByName String
    Name of user who last updated this metric ruleset
    version String
    Version of the ruleset
    created string
    Timestamp of when the metric ruleset was created
    creator string
    ID of the creator of the metric ruleset
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated string
    Timestamp of when the metric ruleset was last updated
    lastUpdatedBy string
    ID of user who last updated the metric ruleset
    lastUpdatedByName string
    Name of user who last updated this metric ruleset
    version string
    Version of the ruleset
    created str
    Timestamp of when the metric ruleset was created
    creator str
    ID of the creator of the metric ruleset
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated str
    Timestamp of when the metric ruleset was last updated
    last_updated_by str
    ID of user who last updated the metric ruleset
    last_updated_by_name str
    Name of user who last updated this metric ruleset
    version str
    Version of the ruleset
    created String
    Timestamp of when the metric ruleset was created
    creator String
    ID of the creator of the metric ruleset
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    Timestamp of when the metric ruleset was last updated
    lastUpdatedBy String
    ID of user who last updated the metric ruleset
    lastUpdatedByName String
    Name of user who last updated this metric ruleset
    version String
    Version of the ruleset

    Look up Existing MetricRuleset Resource

    Get an existing MetricRuleset 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?: MetricRulesetState, opts?: CustomResourceOptions): MetricRuleset
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggregation_rules: Optional[Sequence[MetricRulesetAggregationRuleArgs]] = None,
        created: Optional[str] = None,
        creator: Optional[str] = None,
        description: Optional[str] = None,
        exception_rules: Optional[Sequence[MetricRulesetExceptionRuleArgs]] = None,
        last_updated: Optional[str] = None,
        last_updated_by: Optional[str] = None,
        last_updated_by_name: Optional[str] = None,
        metric_name: Optional[str] = None,
        routing_rules: Optional[Sequence[MetricRulesetRoutingRuleArgs]] = None,
        version: Optional[str] = None) -> MetricRuleset
    func GetMetricRuleset(ctx *Context, name string, id IDInput, state *MetricRulesetState, opts ...ResourceOption) (*MetricRuleset, error)
    public static MetricRuleset Get(string name, Input<string> id, MetricRulesetState? state, CustomResourceOptions? opts = null)
    public static MetricRuleset get(String name, Output<String> id, MetricRulesetState state, CustomResourceOptions options)
    resources:  _:    type: signalfx:MetricRuleset    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:
    AggregationRules List<Pulumi.SignalFx.Inputs.MetricRulesetAggregationRule>
    List of aggregation rules for the metric
    Created string
    Timestamp of when the metric ruleset was created
    Creator string
    ID of the creator of the metric ruleset
    Description string
    Information about the metric ruleset
    ExceptionRules List<Pulumi.SignalFx.Inputs.MetricRulesetExceptionRule>
    List of exception rules for the metric
    LastUpdated string
    Timestamp of when the metric ruleset was last updated
    LastUpdatedBy string
    ID of user who last updated the metric ruleset
    LastUpdatedByName string
    Name of user who last updated this metric ruleset
    MetricName string
    Name of the input metric
    RoutingRules List<Pulumi.SignalFx.Inputs.MetricRulesetRoutingRule>
    Routing Rule object
    Version string
    Version of the ruleset
    AggregationRules []MetricRulesetAggregationRuleArgs
    List of aggregation rules for the metric
    Created string
    Timestamp of when the metric ruleset was created
    Creator string
    ID of the creator of the metric ruleset
    Description string
    Information about the metric ruleset
    ExceptionRules []MetricRulesetExceptionRuleArgs
    List of exception rules for the metric
    LastUpdated string
    Timestamp of when the metric ruleset was last updated
    LastUpdatedBy string
    ID of user who last updated the metric ruleset
    LastUpdatedByName string
    Name of user who last updated this metric ruleset
    MetricName string
    Name of the input metric
    RoutingRules []MetricRulesetRoutingRuleArgs
    Routing Rule object
    Version string
    Version of the ruleset
    aggregationRules List<MetricRulesetAggregationRule>
    List of aggregation rules for the metric
    created String
    Timestamp of when the metric ruleset was created
    creator String
    ID of the creator of the metric ruleset
    description String
    Information about the metric ruleset
    exceptionRules List<MetricRulesetExceptionRule>
    List of exception rules for the metric
    lastUpdated String
    Timestamp of when the metric ruleset was last updated
    lastUpdatedBy String
    ID of user who last updated the metric ruleset
    lastUpdatedByName String
    Name of user who last updated this metric ruleset
    metricName String
    Name of the input metric
    routingRules List<MetricRulesetRoutingRule>
    Routing Rule object
    version String
    Version of the ruleset
    aggregationRules MetricRulesetAggregationRule[]
    List of aggregation rules for the metric
    created string
    Timestamp of when the metric ruleset was created
    creator string
    ID of the creator of the metric ruleset
    description string
    Information about the metric ruleset
    exceptionRules MetricRulesetExceptionRule[]
    List of exception rules for the metric
    lastUpdated string
    Timestamp of when the metric ruleset was last updated
    lastUpdatedBy string
    ID of user who last updated the metric ruleset
    lastUpdatedByName string
    Name of user who last updated this metric ruleset
    metricName string
    Name of the input metric
    routingRules MetricRulesetRoutingRule[]
    Routing Rule object
    version string
    Version of the ruleset
    aggregation_rules Sequence[MetricRulesetAggregationRuleArgs]
    List of aggregation rules for the metric
    created str
    Timestamp of when the metric ruleset was created
    creator str
    ID of the creator of the metric ruleset
    description str
    Information about the metric ruleset
    exception_rules Sequence[MetricRulesetExceptionRuleArgs]
    List of exception rules for the metric
    last_updated str
    Timestamp of when the metric ruleset was last updated
    last_updated_by str
    ID of user who last updated the metric ruleset
    last_updated_by_name str
    Name of user who last updated this metric ruleset
    metric_name str
    Name of the input metric
    routing_rules Sequence[MetricRulesetRoutingRuleArgs]
    Routing Rule object
    version str
    Version of the ruleset
    aggregationRules List<Property Map>
    List of aggregation rules for the metric
    created String
    Timestamp of when the metric ruleset was created
    creator String
    ID of the creator of the metric ruleset
    description String
    Information about the metric ruleset
    exceptionRules List<Property Map>
    List of exception rules for the metric
    lastUpdated String
    Timestamp of when the metric ruleset was last updated
    lastUpdatedBy String
    ID of user who last updated the metric ruleset
    lastUpdatedByName String
    Name of user who last updated this metric ruleset
    metricName String
    Name of the input metric
    routingRules List<Property Map>
    Routing Rule object
    version String
    Version of the ruleset

    Supporting Types

    MetricRulesetAggregationRule, MetricRulesetAggregationRuleArgs

    Aggregators List<Pulumi.SignalFx.Inputs.MetricRulesetAggregationRuleAggregator>
    Aggregator object
    Enabled bool
    When false, this rule will not generate aggregated MTSs
    Matchers List<Pulumi.SignalFx.Inputs.MetricRulesetAggregationRuleMatcher>
    Matcher object
    Description string
    Information about an aggregation rule
    Name string
    name of the aggregation rule
    Aggregators []MetricRulesetAggregationRuleAggregator
    Aggregator object
    Enabled bool
    When false, this rule will not generate aggregated MTSs
    Matchers []MetricRulesetAggregationRuleMatcher
    Matcher object
    Description string
    Information about an aggregation rule
    Name string
    name of the aggregation rule
    aggregators List<MetricRulesetAggregationRuleAggregator>
    Aggregator object
    enabled Boolean
    When false, this rule will not generate aggregated MTSs
    matchers List<MetricRulesetAggregationRuleMatcher>
    Matcher object
    description String
    Information about an aggregation rule
    name String
    name of the aggregation rule
    aggregators MetricRulesetAggregationRuleAggregator[]
    Aggregator object
    enabled boolean
    When false, this rule will not generate aggregated MTSs
    matchers MetricRulesetAggregationRuleMatcher[]
    Matcher object
    description string
    Information about an aggregation rule
    name string
    name of the aggregation rule
    aggregators Sequence[MetricRulesetAggregationRuleAggregator]
    Aggregator object
    enabled bool
    When false, this rule will not generate aggregated MTSs
    matchers Sequence[MetricRulesetAggregationRuleMatcher]
    Matcher object
    description str
    Information about an aggregation rule
    name str
    name of the aggregation rule
    aggregators List<Property Map>
    Aggregator object
    enabled Boolean
    When false, this rule will not generate aggregated MTSs
    matchers List<Property Map>
    Matcher object
    description String
    Information about an aggregation rule
    name String
    name of the aggregation rule

    MetricRulesetAggregationRuleAggregator, MetricRulesetAggregationRuleAggregatorArgs

    Dimensions List<string>
    List of dimensions to either be kept or dropped in the new aggregated MTSs
    DropDimensions bool
    when true, the specified dimensions will be dropped from the aggregated MTSs
    OutputName string
    name of the new aggregated metric
    Type string
    Type of aggregator. Must always be "rollup"
    Dimensions []string
    List of dimensions to either be kept or dropped in the new aggregated MTSs
    DropDimensions bool
    when true, the specified dimensions will be dropped from the aggregated MTSs
    OutputName string
    name of the new aggregated metric
    Type string
    Type of aggregator. Must always be "rollup"
    dimensions List<String>
    List of dimensions to either be kept or dropped in the new aggregated MTSs
    dropDimensions Boolean
    when true, the specified dimensions will be dropped from the aggregated MTSs
    outputName String
    name of the new aggregated metric
    type String
    Type of aggregator. Must always be "rollup"
    dimensions string[]
    List of dimensions to either be kept or dropped in the new aggregated MTSs
    dropDimensions boolean
    when true, the specified dimensions will be dropped from the aggregated MTSs
    outputName string
    name of the new aggregated metric
    type string
    Type of aggregator. Must always be "rollup"
    dimensions Sequence[str]
    List of dimensions to either be kept or dropped in the new aggregated MTSs
    drop_dimensions bool
    when true, the specified dimensions will be dropped from the aggregated MTSs
    output_name str
    name of the new aggregated metric
    type str
    Type of aggregator. Must always be "rollup"
    dimensions List<String>
    List of dimensions to either be kept or dropped in the new aggregated MTSs
    dropDimensions Boolean
    when true, the specified dimensions will be dropped from the aggregated MTSs
    outputName String
    name of the new aggregated metric
    type String
    Type of aggregator. Must always be "rollup"

    MetricRulesetAggregationRuleMatcher, MetricRulesetAggregationRuleMatcherArgs

    Type string
    Type of matcher. Must always be "dimension"
    Filters List<Pulumi.SignalFx.Inputs.MetricRulesetAggregationRuleMatcherFilter>
    List of filters to filter the set of input MTSs
    Type string
    Type of matcher. Must always be "dimension"
    Filters []MetricRulesetAggregationRuleMatcherFilter
    List of filters to filter the set of input MTSs
    type String
    Type of matcher. Must always be "dimension"
    filters List<MetricRulesetAggregationRuleMatcherFilter>
    List of filters to filter the set of input MTSs
    type string
    Type of matcher. Must always be "dimension"
    filters MetricRulesetAggregationRuleMatcherFilter[]
    List of filters to filter the set of input MTSs
    type str
    Type of matcher. Must always be "dimension"
    filters Sequence[MetricRulesetAggregationRuleMatcherFilter]
    List of filters to filter the set of input MTSs
    type String
    Type of matcher. Must always be "dimension"
    filters List<Property Map>
    List of filters to filter the set of input MTSs

    MetricRulesetAggregationRuleMatcherFilter, MetricRulesetAggregationRuleMatcherFilterArgs

    Not bool
    When true, this filter will match all values not matching the property_values
    Property string
    Name of the dimension
    PropertyValues List<string>
    Value of the dimension
    Not bool
    When true, this filter will match all values not matching the property_values
    Property string
    Name of the dimension
    PropertyValues []string
    Value of the dimension
    not Boolean
    When true, this filter will match all values not matching the property_values
    property String
    Name of the dimension
    propertyValues List<String>
    Value of the dimension
    not boolean
    When true, this filter will match all values not matching the property_values
    property string
    Name of the dimension
    propertyValues string[]
    Value of the dimension
    not_ bool
    When true, this filter will match all values not matching the property_values
    property str
    Name of the dimension
    property_values Sequence[str]
    Value of the dimension
    not Boolean
    When true, this filter will match all values not matching the property_values
    property String
    Name of the dimension
    propertyValues List<String>
    Value of the dimension

    MetricRulesetExceptionRule, MetricRulesetExceptionRuleArgs

    Enabled bool
    When false, this rule will not route matched data to real-time
    Matchers List<Pulumi.SignalFx.Inputs.MetricRulesetExceptionRuleMatcher>
    Matcher object
    Description string
    Information about an exception rule
    Name string
    name of the exception rule
    Restorations List<Pulumi.SignalFx.Inputs.MetricRulesetExceptionRuleRestoration>
    Properties of a restoration job
    Enabled bool
    When false, this rule will not route matched data to real-time
    Matchers []MetricRulesetExceptionRuleMatcher
    Matcher object
    Description string
    Information about an exception rule
    Name string
    name of the exception rule
    Restorations []MetricRulesetExceptionRuleRestoration
    Properties of a restoration job
    enabled Boolean
    When false, this rule will not route matched data to real-time
    matchers List<MetricRulesetExceptionRuleMatcher>
    Matcher object
    description String
    Information about an exception rule
    name String
    name of the exception rule
    restorations List<MetricRulesetExceptionRuleRestoration>
    Properties of a restoration job
    enabled boolean
    When false, this rule will not route matched data to real-time
    matchers MetricRulesetExceptionRuleMatcher[]
    Matcher object
    description string
    Information about an exception rule
    name string
    name of the exception rule
    restorations MetricRulesetExceptionRuleRestoration[]
    Properties of a restoration job
    enabled bool
    When false, this rule will not route matched data to real-time
    matchers Sequence[MetricRulesetExceptionRuleMatcher]
    Matcher object
    description str
    Information about an exception rule
    name str
    name of the exception rule
    restorations Sequence[MetricRulesetExceptionRuleRestoration]
    Properties of a restoration job
    enabled Boolean
    When false, this rule will not route matched data to real-time
    matchers List<Property Map>
    Matcher object
    description String
    Information about an exception rule
    name String
    name of the exception rule
    restorations List<Property Map>
    Properties of a restoration job

    MetricRulesetExceptionRuleMatcher, MetricRulesetExceptionRuleMatcherArgs

    Type string
    Type of matcher. Must always be "dimension"
    Filters List<Pulumi.SignalFx.Inputs.MetricRulesetExceptionRuleMatcherFilter>
    List of filters to filter the set of input MTSs
    Type string
    Type of matcher. Must always be "dimension"
    Filters []MetricRulesetExceptionRuleMatcherFilter
    List of filters to filter the set of input MTSs
    type String
    Type of matcher. Must always be "dimension"
    filters List<MetricRulesetExceptionRuleMatcherFilter>
    List of filters to filter the set of input MTSs
    type string
    Type of matcher. Must always be "dimension"
    filters MetricRulesetExceptionRuleMatcherFilter[]
    List of filters to filter the set of input MTSs
    type str
    Type of matcher. Must always be "dimension"
    filters Sequence[MetricRulesetExceptionRuleMatcherFilter]
    List of filters to filter the set of input MTSs
    type String
    Type of matcher. Must always be "dimension"
    filters List<Property Map>
    List of filters to filter the set of input MTSs

    MetricRulesetExceptionRuleMatcherFilter, MetricRulesetExceptionRuleMatcherFilterArgs

    Not bool
    When true, this filter will match all values not matching the property_values
    Property string
    Name of the dimension
    PropertyValues List<string>
    Value of the dimension
    Not bool
    When true, this filter will match all values not matching the property_values
    Property string
    Name of the dimension
    PropertyValues []string
    Value of the dimension
    not Boolean
    When true, this filter will match all values not matching the property_values
    property String
    Name of the dimension
    propertyValues List<String>
    Value of the dimension
    not boolean
    When true, this filter will match all values not matching the property_values
    property string
    Name of the dimension
    propertyValues string[]
    Value of the dimension
    not_ bool
    When true, this filter will match all values not matching the property_values
    property str
    Name of the dimension
    property_values Sequence[str]
    Value of the dimension
    not Boolean
    When true, this filter will match all values not matching the property_values
    property String
    Name of the dimension
    propertyValues List<String>
    Value of the dimension

    MetricRulesetExceptionRuleRestoration, MetricRulesetExceptionRuleRestorationArgs

    StartTime string
    Time from which the restoration job will restore archived data, in the form of *nix time in milliseconds
    RestorationId string
    ID of the restoration job.
    StopTime string
    Time to which the restoration job will restore archived data, in the form of *nix time in milliseconds
    StartTime string
    Time from which the restoration job will restore archived data, in the form of *nix time in milliseconds
    RestorationId string
    ID of the restoration job.
    StopTime string
    Time to which the restoration job will restore archived data, in the form of *nix time in milliseconds
    startTime String
    Time from which the restoration job will restore archived data, in the form of *nix time in milliseconds
    restorationId String
    ID of the restoration job.
    stopTime String
    Time to which the restoration job will restore archived data, in the form of *nix time in milliseconds
    startTime string
    Time from which the restoration job will restore archived data, in the form of *nix time in milliseconds
    restorationId string
    ID of the restoration job.
    stopTime string
    Time to which the restoration job will restore archived data, in the form of *nix time in milliseconds
    start_time str
    Time from which the restoration job will restore archived data, in the form of *nix time in milliseconds
    restoration_id str
    ID of the restoration job.
    stop_time str
    Time to which the restoration job will restore archived data, in the form of *nix time in milliseconds
    startTime String
    Time from which the restoration job will restore archived data, in the form of *nix time in milliseconds
    restorationId String
    ID of the restoration job.
    stopTime String
    Time to which the restoration job will restore archived data, in the form of *nix time in milliseconds

    MetricRulesetRoutingRule, MetricRulesetRoutingRuleArgs

    Destination string
    end destination of the input metric. Must be RealTime, Archived, or Drop
    Destination string
    end destination of the input metric. Must be RealTime, Archived, or Drop
    destination String
    end destination of the input metric. Must be RealTime, Archived, or Drop
    destination string
    end destination of the input metric. Must be RealTime, Archived, or Drop
    destination str
    end destination of the input metric. Must be RealTime, Archived, or Drop
    destination String
    end destination of the input metric. Must be RealTime, Archived, or Drop

    Package Details

    Repository
    SignalFx pulumi/pulumi-signalfx
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the signalfx Terraform Provider.
    signalfx logo
    SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
    pulumi/pulumi-signalfx