1. Packages
  2. SignalFx
  3. API Docs
  4. AlertMutingRule
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi

signalfx.AlertMutingRule

Explore with Pulumi AI

signalfx logo
SignalFx v7.1.1 published on Tuesday, Feb 27, 2024 by Pulumi

    Provides a Splunk Observability Cloud resource for managing alert muting rules. See Mute Notifications for more information.

    Splunk Observability Cloud currently allows linking an alert muting rule with only one detector ID. Specifying multiple detector IDs makes the muting rule obsolete.

    WARNING Splunk Observability Cloud does not allow the start time of a currently active muting rule to be modified. Attempting to modify a currently active rule destroys the existing rule and creates a new rule. This might result in the emission of notifications.

    Example

    import * as pulumi from "@pulumi/pulumi";
    import * as signalfx from "@pulumi/signalfx";
    
    const roolMooterOne = new signalfx.AlertMutingRule("roolMooterOne", {
        description: "mooted it NEW",
        startTime: 1573063243,
        stopTime: 0,
        detectors: [signalfx_detector.some_detector_id],
        filters: [{
            property: "foo",
            propertyValue: "bar",
        }],
    });
    
    import pulumi
    import pulumi_signalfx as signalfx
    
    rool_mooter_one = signalfx.AlertMutingRule("roolMooterOne",
        description="mooted it NEW",
        start_time=1573063243,
        stop_time=0,
        detectors=[signalfx_detector["some_detector_id"]],
        filters=[signalfx.AlertMutingRuleFilterArgs(
            property="foo",
            property_value="bar",
        )])
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using SignalFx = Pulumi.SignalFx;
    
    return await Deployment.RunAsync(() => 
    {
        var roolMooterOne = new SignalFx.AlertMutingRule("roolMooterOne", new()
        {
            Description = "mooted it NEW",
            StartTime = 1573063243,
            StopTime = 0,
            Detectors = new[]
            {
                signalfx_detector.Some_detector_id,
            },
            Filters = new[]
            {
                new SignalFx.Inputs.AlertMutingRuleFilterArgs
                {
                    Property = "foo",
                    PropertyValue = "bar",
                },
            },
        });
    
    });
    
    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.NewAlertMutingRule(ctx, "roolMooterOne", &signalfx.AlertMutingRuleArgs{
    			Description: pulumi.String("mooted it NEW"),
    			StartTime:   pulumi.Int(1573063243),
    			StopTime:    pulumi.Int(0),
    			Detectors: pulumi.StringArray{
    				signalfx_detector.Some_detector_id,
    			},
    			Filters: signalfx.AlertMutingRuleFilterArray{
    				&signalfx.AlertMutingRuleFilterArgs{
    					Property:      pulumi.String("foo"),
    					PropertyValue: pulumi.String("bar"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.signalfx.AlertMutingRule;
    import com.pulumi.signalfx.AlertMutingRuleArgs;
    import com.pulumi.signalfx.inputs.AlertMutingRuleFilterArgs;
    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 roolMooterOne = new AlertMutingRule("roolMooterOne", AlertMutingRuleArgs.builder()        
                .description("mooted it NEW")
                .startTime(1573063243)
                .stopTime(0)
                .detectors(signalfx_detector.some_detector_id())
                .filters(AlertMutingRuleFilterArgs.builder()
                    .property("foo")
                    .propertyValue("bar")
                    .build())
                .build());
    
        }
    }
    
    resources:
      roolMooterOne:
        type: signalfx:AlertMutingRule
        properties:
          description: mooted it NEW
          startTime: 1.573063243e+09
          stopTime: 0 # Defaults to 0
          detectors:
            - ${signalfx_detector.some_detector_id}
          filters:
            - property: foo
              propertyValue: bar
    

    Arguments

    • description - (Required) The description for this muting rule
    • start_time - (Required) Starting time of an alert muting rule as a Unit time stamp in seconds.
    • stop_time - (Optional) Stop time of an alert muting rule as a Unix time stamp in seconds.
    • detectors - (Optional) A convenience attribute that associated this muting rule with specific detector IDs. Currently, only one ID is supported.
    • filter - (Optional) Filters for this rule. See Creating muting rules from scratch for more information.
      • property - (Required) The property to filter.
      • property_value - (Required) The property value to filter.
      • negated - (Optional) Determines if this is a “not” filter. Defaults to false.

    Attributes

    In a addition to all arguments above, the following attributes are exported:

    • id - The ID of the alert muting rule.
    • effective_start_time

    Create AlertMutingRule Resource

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

    Constructor syntax

    new AlertMutingRule(name: string, args: AlertMutingRuleArgs, opts?: CustomResourceOptions);
    @overload
    def AlertMutingRule(resource_name: str,
                        args: AlertMutingRuleArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def AlertMutingRule(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        start_time: Optional[int] = None,
                        detectors: Optional[Sequence[str]] = None,
                        filters: Optional[Sequence[AlertMutingRuleFilterArgs]] = None,
                        stop_time: Optional[int] = None)
    func NewAlertMutingRule(ctx *Context, name string, args AlertMutingRuleArgs, opts ...ResourceOption) (*AlertMutingRule, error)
    public AlertMutingRule(string name, AlertMutingRuleArgs args, CustomResourceOptions? opts = null)
    public AlertMutingRule(String name, AlertMutingRuleArgs args)
    public AlertMutingRule(String name, AlertMutingRuleArgs args, CustomResourceOptions options)
    
    type: signalfx:AlertMutingRule
    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 AlertMutingRuleArgs
    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 AlertMutingRuleArgs
    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 AlertMutingRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlertMutingRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlertMutingRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var alertMutingRuleResource = new SignalFx.AlertMutingRule("alertMutingRuleResource", new()
    {
        Description = "string",
        StartTime = 0,
        Detectors = new[]
        {
            "string",
        },
        Filters = new[]
        {
            new SignalFx.Inputs.AlertMutingRuleFilterArgs
            {
                Property = "string",
                PropertyValue = "string",
                Negated = false,
            },
        },
        StopTime = 0,
    });
    
    example, err := signalfx.NewAlertMutingRule(ctx, "alertMutingRuleResource", &signalfx.AlertMutingRuleArgs{
    	Description: pulumi.String("string"),
    	StartTime:   pulumi.Int(0),
    	Detectors: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Filters: signalfx.AlertMutingRuleFilterArray{
    		&signalfx.AlertMutingRuleFilterArgs{
    			Property:      pulumi.String("string"),
    			PropertyValue: pulumi.String("string"),
    			Negated:       pulumi.Bool(false),
    		},
    	},
    	StopTime: pulumi.Int(0),
    })
    
    var alertMutingRuleResource = new AlertMutingRule("alertMutingRuleResource", AlertMutingRuleArgs.builder()        
        .description("string")
        .startTime(0)
        .detectors("string")
        .filters(AlertMutingRuleFilterArgs.builder()
            .property("string")
            .propertyValue("string")
            .negated(false)
            .build())
        .stopTime(0)
        .build());
    
    alert_muting_rule_resource = signalfx.AlertMutingRule("alertMutingRuleResource",
        description="string",
        start_time=0,
        detectors=["string"],
        filters=[signalfx.AlertMutingRuleFilterArgs(
            property="string",
            property_value="string",
            negated=False,
        )],
        stop_time=0)
    
    const alertMutingRuleResource = new signalfx.AlertMutingRule("alertMutingRuleResource", {
        description: "string",
        startTime: 0,
        detectors: ["string"],
        filters: [{
            property: "string",
            propertyValue: "string",
            negated: false,
        }],
        stopTime: 0,
    });
    
    type: signalfx:AlertMutingRule
    properties:
        description: string
        detectors:
            - string
        filters:
            - negated: false
              property: string
              propertyValue: string
        startTime: 0
        stopTime: 0
    

    AlertMutingRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AlertMutingRule resource accepts the following input properties:

    Description string
    description of the rule
    StartTime int
    starting time of an alert muting rule as a Unix timestamp, in seconds
    Detectors List<string>
    detectors to which this muting rule applies
    Filters List<Pulumi.SignalFx.Inputs.AlertMutingRuleFilter>
    list of alert muting filters for this rule
    StopTime int
    stop time of an alert muting rule as a Unix timestamp, in seconds
    Description string
    description of the rule
    StartTime int
    starting time of an alert muting rule as a Unix timestamp, in seconds
    Detectors []string
    detectors to which this muting rule applies
    Filters []AlertMutingRuleFilterArgs
    list of alert muting filters for this rule
    StopTime int
    stop time of an alert muting rule as a Unix timestamp, in seconds
    description String
    description of the rule
    startTime Integer
    starting time of an alert muting rule as a Unix timestamp, in seconds
    detectors List<String>
    detectors to which this muting rule applies
    filters List<AlertMutingRuleFilter>
    list of alert muting filters for this rule
    stopTime Integer
    stop time of an alert muting rule as a Unix timestamp, in seconds
    description string
    description of the rule
    startTime number
    starting time of an alert muting rule as a Unix timestamp, in seconds
    detectors string[]
    detectors to which this muting rule applies
    filters AlertMutingRuleFilter[]
    list of alert muting filters for this rule
    stopTime number
    stop time of an alert muting rule as a Unix timestamp, in seconds
    description str
    description of the rule
    start_time int
    starting time of an alert muting rule as a Unix timestamp, in seconds
    detectors Sequence[str]
    detectors to which this muting rule applies
    filters Sequence[AlertMutingRuleFilterArgs]
    list of alert muting filters for this rule
    stop_time int
    stop time of an alert muting rule as a Unix timestamp, in seconds
    description String
    description of the rule
    startTime Number
    starting time of an alert muting rule as a Unix timestamp, in seconds
    detectors List<String>
    detectors to which this muting rule applies
    filters List<Property Map>
    list of alert muting filters for this rule
    stopTime Number
    stop time of an alert muting rule as a Unix timestamp, in seconds

    Outputs

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

    EffectiveStartTime int
    Id string
    The provider-assigned unique ID for this managed resource.
    EffectiveStartTime int
    Id string
    The provider-assigned unique ID for this managed resource.
    effectiveStartTime Integer
    id String
    The provider-assigned unique ID for this managed resource.
    effectiveStartTime number
    id string
    The provider-assigned unique ID for this managed resource.
    effective_start_time int
    id str
    The provider-assigned unique ID for this managed resource.
    effectiveStartTime Number
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AlertMutingRule Resource

    Get an existing AlertMutingRule 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?: AlertMutingRuleState, opts?: CustomResourceOptions): AlertMutingRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            detectors: Optional[Sequence[str]] = None,
            effective_start_time: Optional[int] = None,
            filters: Optional[Sequence[AlertMutingRuleFilterArgs]] = None,
            start_time: Optional[int] = None,
            stop_time: Optional[int] = None) -> AlertMutingRule
    func GetAlertMutingRule(ctx *Context, name string, id IDInput, state *AlertMutingRuleState, opts ...ResourceOption) (*AlertMutingRule, error)
    public static AlertMutingRule Get(string name, Input<string> id, AlertMutingRuleState? state, CustomResourceOptions? opts = null)
    public static AlertMutingRule get(String name, Output<String> id, AlertMutingRuleState 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.
    The following state arguments are supported:
    Description string
    description of the rule
    Detectors List<string>
    detectors to which this muting rule applies
    EffectiveStartTime int
    Filters List<Pulumi.SignalFx.Inputs.AlertMutingRuleFilter>
    list of alert muting filters for this rule
    StartTime int
    starting time of an alert muting rule as a Unix timestamp, in seconds
    StopTime int
    stop time of an alert muting rule as a Unix timestamp, in seconds
    Description string
    description of the rule
    Detectors []string
    detectors to which this muting rule applies
    EffectiveStartTime int
    Filters []AlertMutingRuleFilterArgs
    list of alert muting filters for this rule
    StartTime int
    starting time of an alert muting rule as a Unix timestamp, in seconds
    StopTime int
    stop time of an alert muting rule as a Unix timestamp, in seconds
    description String
    description of the rule
    detectors List<String>
    detectors to which this muting rule applies
    effectiveStartTime Integer
    filters List<AlertMutingRuleFilter>
    list of alert muting filters for this rule
    startTime Integer
    starting time of an alert muting rule as a Unix timestamp, in seconds
    stopTime Integer
    stop time of an alert muting rule as a Unix timestamp, in seconds
    description string
    description of the rule
    detectors string[]
    detectors to which this muting rule applies
    effectiveStartTime number
    filters AlertMutingRuleFilter[]
    list of alert muting filters for this rule
    startTime number
    starting time of an alert muting rule as a Unix timestamp, in seconds
    stopTime number
    stop time of an alert muting rule as a Unix timestamp, in seconds
    description str
    description of the rule
    detectors Sequence[str]
    detectors to which this muting rule applies
    effective_start_time int
    filters Sequence[AlertMutingRuleFilterArgs]
    list of alert muting filters for this rule
    start_time int
    starting time of an alert muting rule as a Unix timestamp, in seconds
    stop_time int
    stop time of an alert muting rule as a Unix timestamp, in seconds
    description String
    description of the rule
    detectors List<String>
    detectors to which this muting rule applies
    effectiveStartTime Number
    filters List<Property Map>
    list of alert muting filters for this rule
    startTime Number
    starting time of an alert muting rule as a Unix timestamp, in seconds
    stopTime Number
    stop time of an alert muting rule as a Unix timestamp, in seconds

    Supporting Types

    AlertMutingRuleFilter, AlertMutingRuleFilterArgs

    Property string
    the property to filter by
    PropertyValue string
    the value of the property to filter by
    Negated bool
    (false by default) whether this filter should be a "not" filter
    Property string
    the property to filter by
    PropertyValue string
    the value of the property to filter by
    Negated bool
    (false by default) whether this filter should be a "not" filter
    property String
    the property to filter by
    propertyValue String
    the value of the property to filter by
    negated Boolean
    (false by default) whether this filter should be a "not" filter
    property string
    the property to filter by
    propertyValue string
    the value of the property to filter by
    negated boolean
    (false by default) whether this filter should be a "not" filter
    property str
    the property to filter by
    property_value str
    the value of the property to filter by
    negated bool
    (false by default) whether this filter should be a "not" filter
    property String
    the property to filter by
    propertyValue String
    the value of the property to filter by
    negated Boolean
    (false by default) whether this filter should be a "not" filter

    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.1.1 published on Tuesday, Feb 27, 2024 by Pulumi