1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Monitoring
  5. getAlarmSuppression
Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi

oci.Monitoring.getAlarmSuppression

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.2.0 published on Friday, Jul 12, 2024 by Pulumi

    This data source provides details about a specific Alarm Suppression resource in Oracle Cloud Infrastructure Monitoring service.

    Gets the specified alarm suppression.

    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 = oci.Monitoring.getAlarmSuppression({
        alarmSuppressionId: testAlarmSuppressionOciMonitoringAlarmSuppression.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_alarm_suppression = oci.Monitoring.get_alarm_suppression(alarm_suppression_id=test_alarm_suppression_oci_monitoring_alarm_suppression["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Monitoring"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Monitoring.GetAlarmSuppression(ctx, &monitoring.GetAlarmSuppressionArgs{
    			AlarmSuppressionId: testAlarmSuppressionOciMonitoringAlarmSuppression.Id,
    		}, nil)
    		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 = Oci.Monitoring.GetAlarmSuppression.Invoke(new()
        {
            AlarmSuppressionId = testAlarmSuppressionOciMonitoringAlarmSuppression.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Monitoring.MonitoringFunctions;
    import com.pulumi.oci.Monitoring.inputs.GetAlarmSuppressionArgs;
    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) {
            final var testAlarmSuppression = MonitoringFunctions.getAlarmSuppression(GetAlarmSuppressionArgs.builder()
                .alarmSuppressionId(testAlarmSuppressionOciMonitoringAlarmSuppression.id())
                .build());
    
        }
    }
    
    variables:
      testAlarmSuppression:
        fn::invoke:
          Function: oci:Monitoring:getAlarmSuppression
          Arguments:
            alarmSuppressionId: ${testAlarmSuppressionOciMonitoringAlarmSuppression.id}
    

    Using getAlarmSuppression

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getAlarmSuppression(args: GetAlarmSuppressionArgs, opts?: InvokeOptions): Promise<GetAlarmSuppressionResult>
    function getAlarmSuppressionOutput(args: GetAlarmSuppressionOutputArgs, opts?: InvokeOptions): Output<GetAlarmSuppressionResult>
    def get_alarm_suppression(alarm_suppression_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAlarmSuppressionResult
    def get_alarm_suppression_output(alarm_suppression_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAlarmSuppressionResult]
    func GetAlarmSuppression(ctx *Context, args *GetAlarmSuppressionArgs, opts ...InvokeOption) (*GetAlarmSuppressionResult, error)
    func GetAlarmSuppressionOutput(ctx *Context, args *GetAlarmSuppressionOutputArgs, opts ...InvokeOption) GetAlarmSuppressionResultOutput

    > Note: This function is named GetAlarmSuppression in the Go SDK.

    public static class GetAlarmSuppression 
    {
        public static Task<GetAlarmSuppressionResult> InvokeAsync(GetAlarmSuppressionArgs args, InvokeOptions? opts = null)
        public static Output<GetAlarmSuppressionResult> Invoke(GetAlarmSuppressionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAlarmSuppressionResult> getAlarmSuppression(GetAlarmSuppressionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Monitoring/getAlarmSuppression:getAlarmSuppression
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AlarmSuppressionId string
    The OCID of the alarm suppression.
    AlarmSuppressionId string
    The OCID of the alarm suppression.
    alarmSuppressionId String
    The OCID of the alarm suppression.
    alarmSuppressionId string
    The OCID of the alarm suppression.
    alarm_suppression_id str
    The OCID of the alarm suppression.
    alarmSuppressionId String
    The OCID of the alarm suppression.

    getAlarmSuppression Result

    The following output properties are available:

    AlarmSuppressionId string
    AlarmSuppressionTargets List<GetAlarmSuppressionAlarmSuppressionTarget>
    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.
    Dimensions Dictionary<string, object>
    Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
    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"}
    Id string
    The OCID of the alarm suppression.
    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: 2018-02-01T01:02:29.600Z
    TimeSuppressUntil string
    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02: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
    AlarmSuppressionId string
    AlarmSuppressionTargets []GetAlarmSuppressionAlarmSuppressionTarget
    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.
    Dimensions map[string]interface{}
    Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
    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"}
    Id string
    The OCID of the alarm suppression.
    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: 2018-02-01T01:02:29.600Z
    TimeSuppressUntil string
    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02: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
    alarmSuppressionId String
    alarmSuppressionTargets List<GetAlarmSuppressionAlarmSuppressionTarget>
    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.
    dimensions Map<String,Object>
    Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
    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"}
    id String
    The OCID of the alarm suppression.
    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: 2018-02-01T01:02:29.600Z
    timeSuppressUntil String
    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02: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
    alarmSuppressionId string
    alarmSuppressionTargets GetAlarmSuppressionAlarmSuppressionTarget[]
    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.
    dimensions {[key: string]: any}
    Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
    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"}
    id string
    The OCID of the alarm suppression.
    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: 2018-02-01T01:02:29.600Z
    timeSuppressUntil string
    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02: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
    alarm_suppression_id str
    alarm_suppression_targets Sequence[monitoring.GetAlarmSuppressionAlarmSuppressionTarget]
    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.
    dimensions Mapping[str, Any]
    Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
    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"}
    id str
    The OCID of the alarm suppression.
    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: 2018-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: 2018-02-01T02: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
    alarmSuppressionId String
    alarmSuppressionTargets List<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.
    dimensions Map<Any>
    Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}
    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"}
    id String
    The OCID of the alarm suppression.
    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: 2018-02-01T01:02:29.600Z
    timeSuppressUntil String
    The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02: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

    Supporting Types

    GetAlarmSuppressionAlarmSuppressionTarget

    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.

    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 v2.2.0 published on Friday, Jul 12, 2024 by Pulumi