1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Monitoring
  5. AlarmSuppression
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

oci.Monitoring.AlarmSuppression

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi

    This resource provides the Alarm Suppression resource in Oracle Cloud Infrastructure Monitoring service.

    Creates a dimension-specific suppression for an alarm.

    For important limits information, see Limits on Monitoring.

    This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, or transactions, per second (TPS) for a given tenancy.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAlarmSuppression = new oci.monitoring.AlarmSuppression("testAlarmSuppression", {
        alarmSuppressionTarget: {
            alarmId: oci_monitoring_alarm.test_alarm.id,
            targetType: _var.alarm_suppression_alarm_suppression_target_target_type,
        },
        dimensions: _var.alarm_suppression_dimensions,
        displayName: _var.alarm_suppression_display_name,
        timeSuppressFrom: _var.alarm_suppression_time_suppress_from,
        timeSuppressUntil: _var.alarm_suppression_time_suppress_until,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        description: _var.alarm_suppression_description,
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_alarm_suppression = oci.monitoring.AlarmSuppression("testAlarmSuppression",
        alarm_suppression_target=oci.monitoring.AlarmSuppressionAlarmSuppressionTargetArgs(
            alarm_id=oci_monitoring_alarm["test_alarm"]["id"],
            target_type=var["alarm_suppression_alarm_suppression_target_target_type"],
        ),
        dimensions=var["alarm_suppression_dimensions"],
        display_name=var["alarm_suppression_display_name"],
        time_suppress_from=var["alarm_suppression_time_suppress_from"],
        time_suppress_until=var["alarm_suppression_time_suppress_until"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        description=var["alarm_suppression_description"],
        freeform_tags={
            "Department": "Finance",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Monitoring"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Monitoring.NewAlarmSuppression(ctx, "testAlarmSuppression", &Monitoring.AlarmSuppressionArgs{
    			AlarmSuppressionTarget: &monitoring.AlarmSuppressionAlarmSuppressionTargetArgs{
    				AlarmId:    pulumi.Any(oci_monitoring_alarm.Test_alarm.Id),
    				TargetType: pulumi.Any(_var.Alarm_suppression_alarm_suppression_target_target_type),
    			},
    			Dimensions:        pulumi.Any(_var.Alarm_suppression_dimensions),
    			DisplayName:       pulumi.Any(_var.Alarm_suppression_display_name),
    			TimeSuppressFrom:  pulumi.Any(_var.Alarm_suppression_time_suppress_from),
    			TimeSuppressUntil: pulumi.Any(_var.Alarm_suppression_time_suppress_until),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			Description: pulumi.Any(_var.Alarm_suppression_description),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testAlarmSuppression = new Oci.Monitoring.AlarmSuppression("testAlarmSuppression", new()
        {
            AlarmSuppressionTarget = new Oci.Monitoring.Inputs.AlarmSuppressionAlarmSuppressionTargetArgs
            {
                AlarmId = oci_monitoring_alarm.Test_alarm.Id,
                TargetType = @var.Alarm_suppression_alarm_suppression_target_target_type,
            },
            Dimensions = @var.Alarm_suppression_dimensions,
            DisplayName = @var.Alarm_suppression_display_name,
            TimeSuppressFrom = @var.Alarm_suppression_time_suppress_from,
            TimeSuppressUntil = @var.Alarm_suppression_time_suppress_until,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            Description = @var.Alarm_suppression_description,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Monitoring.AlarmSuppression;
    import com.pulumi.oci.Monitoring.AlarmSuppressionArgs;
    import com.pulumi.oci.Monitoring.inputs.AlarmSuppressionAlarmSuppressionTargetArgs;
    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 testAlarmSuppression = new AlarmSuppression("testAlarmSuppression", AlarmSuppressionArgs.builder()        
                .alarmSuppressionTarget(AlarmSuppressionAlarmSuppressionTargetArgs.builder()
                    .alarmId(oci_monitoring_alarm.test_alarm().id())
                    .targetType(var_.alarm_suppression_alarm_suppression_target_target_type())
                    .build())
                .dimensions(var_.alarm_suppression_dimensions())
                .displayName(var_.alarm_suppression_display_name())
                .timeSuppressFrom(var_.alarm_suppression_time_suppress_from())
                .timeSuppressUntil(var_.alarm_suppression_time_suppress_until())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .description(var_.alarm_suppression_description())
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testAlarmSuppression:
        type: oci:Monitoring:AlarmSuppression
        properties:
          alarmSuppressionTarget:
            alarmId: ${oci_monitoring_alarm.test_alarm.id}
            targetType: ${var.alarm_suppression_alarm_suppression_target_target_type}
          dimensions: ${var.alarm_suppression_dimensions}
          displayName: ${var.alarm_suppression_display_name}
          timeSuppressFrom: ${var.alarm_suppression_time_suppress_from}
          timeSuppressUntil: ${var.alarm_suppression_time_suppress_until}
          #Optional
          definedTags:
            Operations.CostCenter: '42'
          description: ${var.alarm_suppression_description}
          freeformTags:
            Department: Finance
    

    Create AlarmSuppression Resource

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

    Constructor syntax

    new AlarmSuppression(name: string, args: AlarmSuppressionArgs, opts?: CustomResourceOptions);
    @overload
    def AlarmSuppression(resource_name: str,
                         args: AlarmSuppressionInitArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AlarmSuppression(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         alarm_suppression_target: Optional[_monitoring.AlarmSuppressionAlarmSuppressionTargetArgs] = None,
                         dimensions: Optional[Mapping[str, Any]] = None,
                         display_name: Optional[str] = None,
                         time_suppress_from: Optional[str] = None,
                         time_suppress_until: Optional[str] = None,
                         defined_tags: Optional[Mapping[str, Any]] = None,
                         description: Optional[str] = None,
                         freeform_tags: Optional[Mapping[str, Any]] = None)
    func NewAlarmSuppression(ctx *Context, name string, args AlarmSuppressionArgs, opts ...ResourceOption) (*AlarmSuppression, error)
    public AlarmSuppression(string name, AlarmSuppressionArgs args, CustomResourceOptions? opts = null)
    public AlarmSuppression(String name, AlarmSuppressionArgs args)
    public AlarmSuppression(String name, AlarmSuppressionArgs args, CustomResourceOptions options)
    
    type: oci:Monitoring:AlarmSuppression
    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 AlarmSuppressionArgs
    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 AlarmSuppressionInitArgs
    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 AlarmSuppressionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlarmSuppressionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlarmSuppressionArgs
    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 alarmSuppressionResource = new Oci.Monitoring.AlarmSuppression("alarmSuppressionResource", new()
    {
        AlarmSuppressionTarget = new Oci.Monitoring.Inputs.AlarmSuppressionAlarmSuppressionTargetArgs
        {
            AlarmId = "string",
            TargetType = "string",
        },
        Dimensions = 
        {
            { "string", "any" },
        },
        DisplayName = "string",
        TimeSuppressFrom = "string",
        TimeSuppressUntil = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        Description = "string",
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := Monitoring.NewAlarmSuppression(ctx, "alarmSuppressionResource", &Monitoring.AlarmSuppressionArgs{
    	AlarmSuppressionTarget: &monitoring.AlarmSuppressionAlarmSuppressionTargetArgs{
    		AlarmId:    pulumi.String("string"),
    		TargetType: pulumi.String("string"),
    	},
    	Dimensions: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	DisplayName:       pulumi.String("string"),
    	TimeSuppressFrom:  pulumi.String("string"),
    	TimeSuppressUntil: pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Description: pulumi.String("string"),
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var alarmSuppressionResource = new AlarmSuppression("alarmSuppressionResource", AlarmSuppressionArgs.builder()        
        .alarmSuppressionTarget(AlarmSuppressionAlarmSuppressionTargetArgs.builder()
            .alarmId("string")
            .targetType("string")
            .build())
        .dimensions(Map.of("string", "any"))
        .displayName("string")
        .timeSuppressFrom("string")
        .timeSuppressUntil("string")
        .definedTags(Map.of("string", "any"))
        .description("string")
        .freeformTags(Map.of("string", "any"))
        .build());
    
    alarm_suppression_resource = oci.monitoring.AlarmSuppression("alarmSuppressionResource",
        alarm_suppression_target=oci.monitoring.AlarmSuppressionAlarmSuppressionTargetArgs(
            alarm_id="string",
            target_type="string",
        ),
        dimensions={
            "string": "any",
        },
        display_name="string",
        time_suppress_from="string",
        time_suppress_until="string",
        defined_tags={
            "string": "any",
        },
        description="string",
        freeform_tags={
            "string": "any",
        })
    
    const alarmSuppressionResource = new oci.monitoring.AlarmSuppression("alarmSuppressionResource", {
        alarmSuppressionTarget: {
            alarmId: "string",
            targetType: "string",
        },
        dimensions: {
            string: "any",
        },
        displayName: "string",
        timeSuppressFrom: "string",
        timeSuppressUntil: "string",
        definedTags: {
            string: "any",
        },
        description: "string",
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:Monitoring:AlarmSuppression
    properties:
        alarmSuppressionTarget:
            alarmId: string
            targetType: string
        definedTags:
            string: any
        description: string
        dimensions:
            string: any
        displayName: string
        freeformTags:
            string: any
        timeSuppressFrom: string
        timeSuppressUntil: string
    

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

    AlarmSuppressionTarget AlarmSuppressionAlarmSuppressionTarget
    The target of the alarm suppression.
    Dimensions Dictionary<string, object>

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    DisplayName string
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    TimeSuppressFrom string
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    TimeSuppressUntil string

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, object>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    Description string

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    AlarmSuppressionTarget AlarmSuppressionAlarmSuppressionTargetArgs
    The target of the alarm suppression.
    Dimensions map[string]interface{}

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    DisplayName string
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    TimeSuppressFrom string
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    TimeSuppressUntil string

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]interface{}
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    Description string

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    alarmSuppressionTarget AlarmSuppressionAlarmSuppressionTarget
    The target of the alarm suppression.
    dimensions Map<String,Object>

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    displayName String
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    timeSuppressFrom String
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    timeSuppressUntil String

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,Object>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    description String

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    alarmSuppressionTarget AlarmSuppressionAlarmSuppressionTarget
    The target of the alarm suppression.
    dimensions {[key: string]: any}

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    displayName string
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    timeSuppressFrom string
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    timeSuppressUntil string

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: any}
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    description string

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    alarm_suppression_target monitoring.AlarmSuppressionAlarmSuppressionTargetArgs
    The target of the alarm suppression.
    dimensions Mapping[str, Any]

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    display_name str
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    time_suppress_from str
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    time_suppress_until str

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, Any]
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    description str

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    alarmSuppressionTarget Property Map
    The target of the alarm suppression.
    dimensions Map<Any>

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    displayName String
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    timeSuppressFrom String
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    timeSuppressUntil String

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<Any>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    description String

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

    Outputs

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

    CompartmentId string
    The OCID of the compartment containing the alarm suppression.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of the alarm suppression. Example: DELETED
    TimeCreated string
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    TimeUpdated string
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    CompartmentId string
    The OCID of the compartment containing the alarm suppression.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current lifecycle state of the alarm suppression. Example: DELETED
    TimeCreated string
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    TimeUpdated string
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    compartmentId String
    The OCID of the compartment containing the alarm suppression.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of the alarm suppression. Example: DELETED
    timeCreated String
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    timeUpdated String
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    compartmentId string
    The OCID of the compartment containing the alarm suppression.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current lifecycle state of the alarm suppression. Example: DELETED
    timeCreated string
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    timeUpdated string
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    compartment_id str
    The OCID of the compartment containing the alarm suppression.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current lifecycle state of the alarm suppression. Example: DELETED
    time_created str
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    time_updated str
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    compartmentId String
    The OCID of the compartment containing the alarm suppression.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current lifecycle state of the alarm suppression. Example: DELETED
    timeCreated String
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    timeUpdated String
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

    Look up Existing AlarmSuppression Resource

    Get an existing AlarmSuppression 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?: AlarmSuppressionState, opts?: CustomResourceOptions): AlarmSuppression
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alarm_suppression_target: Optional[_monitoring.AlarmSuppressionAlarmSuppressionTargetArgs] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            dimensions: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            time_suppress_from: Optional[str] = None,
            time_suppress_until: Optional[str] = None,
            time_updated: Optional[str] = None) -> AlarmSuppression
    func GetAlarmSuppression(ctx *Context, name string, id IDInput, state *AlarmSuppressionState, opts ...ResourceOption) (*AlarmSuppression, error)
    public static AlarmSuppression Get(string name, Input<string> id, AlarmSuppressionState? state, CustomResourceOptions? opts = null)
    public static AlarmSuppression get(String name, Output<String> id, AlarmSuppressionState 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:
    AlarmSuppressionTarget AlarmSuppressionAlarmSuppressionTarget
    The target of the alarm suppression.
    CompartmentId string
    The OCID of the compartment containing the alarm suppression.
    DefinedTags Dictionary<string, object>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    Description string

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    Dimensions Dictionary<string, object>

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    DisplayName string
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    State string
    The current lifecycle state of the alarm suppression. Example: DELETED
    TimeCreated string
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    TimeSuppressFrom string
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    TimeSuppressUntil string

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    TimeUpdated string
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    AlarmSuppressionTarget AlarmSuppressionAlarmSuppressionTargetArgs
    The target of the alarm suppression.
    CompartmentId string
    The OCID of the compartment containing the alarm suppression.
    DefinedTags map[string]interface{}
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    Description string

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    Dimensions map[string]interface{}

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    DisplayName string
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    State string
    The current lifecycle state of the alarm suppression. Example: DELETED
    TimeCreated string
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    TimeSuppressFrom string
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    TimeSuppressUntil string

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    TimeUpdated string
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    alarmSuppressionTarget AlarmSuppressionAlarmSuppressionTarget
    The target of the alarm suppression.
    compartmentId String
    The OCID of the compartment containing the alarm suppression.
    definedTags Map<String,Object>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    description String

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    dimensions Map<String,Object>

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    displayName String
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    state String
    The current lifecycle state of the alarm suppression. Example: DELETED
    timeCreated String
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    timeSuppressFrom String
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    timeSuppressUntil String

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeUpdated String
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    alarmSuppressionTarget AlarmSuppressionAlarmSuppressionTarget
    The target of the alarm suppression.
    compartmentId string
    The OCID of the compartment containing the alarm suppression.
    definedTags {[key: string]: any}
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    description string

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    dimensions {[key: string]: any}

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    displayName string
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    state string
    The current lifecycle state of the alarm suppression. Example: DELETED
    timeCreated string
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    timeSuppressFrom string
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    timeSuppressUntil string

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeUpdated string
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    alarm_suppression_target monitoring.AlarmSuppressionAlarmSuppressionTargetArgs
    The target of the alarm suppression.
    compartment_id str
    The OCID of the compartment containing the alarm suppression.
    defined_tags Mapping[str, Any]
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    description str

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    dimensions Mapping[str, Any]

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    display_name str
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    state str
    The current lifecycle state of the alarm suppression. Example: DELETED
    time_created str
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    time_suppress_from str
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    time_suppress_until str

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    time_updated str
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z
    alarmSuppressionTarget Property Map
    The target of the alarm suppression.
    compartmentId String
    The OCID of the compartment containing the alarm suppression.
    definedTags Map<Any>
    Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}
    description String

    Human-readable reason for this alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.

    Oracle recommends including tracking information for the event or associated work, such as a ticket number.

    Example: Planned outage due to change IT-1234.

    dimensions Map<Any>

    A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {"availabilityDomain": "phx-ad-1"} and the alarm state entry corresponds to the set {"availabilityDomain": "phx-ad-1" and "resourceId": "instance.region1.phx.exampleuniqueID"}, then this alarm will be included for suppression.

    The value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an "dimensions values are too long" message.

    displayName String
    A user-friendly name for the alarm suppression. It does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}
    state String
    The current lifecycle state of the alarm suppression. Example: DELETED
    timeCreated String
    The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z
    timeSuppressFrom String
    The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T01:02:29.600Z
    timeSuppressUntil String

    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2023-02-01T02:02:29.600Z

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeUpdated String
    The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z

    Supporting Types

    AlarmSuppressionAlarmSuppressionTarget, AlarmSuppressionAlarmSuppressionTargetArgs

    AlarmId string
    The OCID of the alarm that is the target of the alarm suppression.
    TargetType string
    The type of the alarm suppression target.
    AlarmId string
    The OCID of the alarm that is the target of the alarm suppression.
    TargetType string
    The type of the alarm suppression target.
    alarmId String
    The OCID of the alarm that is the target of the alarm suppression.
    targetType String
    The type of the alarm suppression target.
    alarmId string
    The OCID of the alarm that is the target of the alarm suppression.
    targetType string
    The type of the alarm suppression target.
    alarm_id str
    The OCID of the alarm that is the target of the alarm suppression.
    target_type str
    The type of the alarm suppression target.
    alarmId String
    The OCID of the alarm that is the target of the alarm suppression.
    targetType String
    The type of the alarm suppression target.

    Import

    AlarmSuppressions can be imported using the id, e.g.

    $ pulumi import oci:Monitoring/alarmSuppression:AlarmSuppression test_alarm_suppression "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.32.0 published on Thursday, Apr 18, 2024 by Pulumi