@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
199 lines • 7.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* 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](https://dev.splunk.com/observability/docs/administration/authtokens#Operations-that-require-a-session-token-for-an-administrator). Otherwise you'll receive a 4xx error.
*
* ## Example
*
* ```typescript
* 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",
* }],
* });
* ```
*/
export declare class MetricRuleset extends pulumi.CustomResource {
/**
* Get an existing MetricRuleset resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MetricRulesetState, opts?: pulumi.CustomResourceOptions): MetricRuleset;
/**
* Returns true if the given object is an instance of MetricRuleset. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is MetricRuleset;
/**
* List of aggregation rules for the metric
*/
readonly aggregationRules: pulumi.Output<outputs.MetricRulesetAggregationRule[] | undefined>;
/**
* Timestamp of when the metric ruleset was created
*/
readonly created: pulumi.Output<string>;
/**
* ID of the creator of the metric ruleset
*/
readonly creator: pulumi.Output<string>;
/**
* Information about the metric ruleset
*/
readonly description: pulumi.Output<string | undefined>;
/**
* List of exception rules for the metric
*/
readonly exceptionRules: pulumi.Output<outputs.MetricRulesetExceptionRule[] | undefined>;
/**
* Timestamp of when the metric ruleset was last updated
*/
readonly lastUpdated: pulumi.Output<string>;
/**
* ID of user who last updated the metric ruleset
*/
readonly lastUpdatedBy: pulumi.Output<string>;
/**
* Name of user who last updated this metric ruleset
*/
readonly lastUpdatedByName: pulumi.Output<string>;
/**
* Name of the input metric
*/
readonly metricName: pulumi.Output<string>;
/**
* Routing Rule object
*/
readonly routingRules: pulumi.Output<outputs.MetricRulesetRoutingRule[]>;
/**
* Version of the ruleset
*/
readonly version: pulumi.Output<string>;
/**
* Create a MetricRuleset resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: MetricRulesetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MetricRuleset resources.
*/
export interface MetricRulesetState {
/**
* List of aggregation rules for the metric
*/
aggregationRules?: pulumi.Input<pulumi.Input<inputs.MetricRulesetAggregationRule>[] | undefined>;
/**
* Timestamp of when the metric ruleset was created
*/
created?: pulumi.Input<string | undefined>;
/**
* ID of the creator of the metric ruleset
*/
creator?: pulumi.Input<string | undefined>;
/**
* Information about the metric ruleset
*/
description?: pulumi.Input<string | undefined>;
/**
* List of exception rules for the metric
*/
exceptionRules?: pulumi.Input<pulumi.Input<inputs.MetricRulesetExceptionRule>[] | undefined>;
/**
* Timestamp of when the metric ruleset was last updated
*/
lastUpdated?: pulumi.Input<string | undefined>;
/**
* ID of user who last updated the metric ruleset
*/
lastUpdatedBy?: pulumi.Input<string | undefined>;
/**
* Name of user who last updated this metric ruleset
*/
lastUpdatedByName?: pulumi.Input<string | undefined>;
/**
* Name of the input metric
*/
metricName?: pulumi.Input<string | undefined>;
/**
* Routing Rule object
*/
routingRules?: pulumi.Input<pulumi.Input<inputs.MetricRulesetRoutingRule>[] | undefined>;
/**
* Version of the ruleset
*/
version?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a MetricRuleset resource.
*/
export interface MetricRulesetArgs {
/**
* List of aggregation rules for the metric
*/
aggregationRules?: pulumi.Input<pulumi.Input<inputs.MetricRulesetAggregationRule>[] | undefined>;
/**
* Information about the metric ruleset
*/
description?: pulumi.Input<string | undefined>;
/**
* List of exception rules for the metric
*/
exceptionRules?: pulumi.Input<pulumi.Input<inputs.MetricRulesetExceptionRule>[] | undefined>;
/**
* Name of the input metric
*/
metricName: pulumi.Input<string>;
/**
* Routing Rule object
*/
routingRules: pulumi.Input<pulumi.Input<inputs.MetricRulesetRoutingRule>[]>;
}
//# sourceMappingURL=metricRuleset.d.ts.map