monitoring

package
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 24, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Alarm

type Alarm struct {
	pulumi.CustomResourceState

	// (Updatable) The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information.  Example: `High CPU usage alert. Follow runbook instructions for resolution.`
	Body pulumi.StringOutput `pulumi:"body"`
	// (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
	CompartmentId pulumi.StringOutput `pulumi:"compartmentId"`
	// (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
	DefinedTags pulumi.MapOutput `pulumi:"definedTags"`
	// (Updatable) A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
	Destinations pulumi.StringArrayOutput `pulumi:"destinations"`
	// (Updatable) A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	//
	// This name is sent as the title for notifications related to this alarm.
	//
	// Example: `High CPU Utilization`
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
	FreeformTags pulumi.MapOutput `pulumi:"freeformTags"`
	// (Updatable) Whether the alarm is enabled.  Example: `true`
	IsEnabled pulumi.BoolOutput `pulumi:"isEnabled"`
	// (Updatable) When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`
	IsNotificationsPerMetricDimensionEnabled pulumi.BoolOutput `pulumi:"isNotificationsPerMetricDimensionEnabled"`
	// (Updatable) The format to use for notification messages sent from this alarm. The formats are:
	MessageFormat pulumi.StringOutput `pulumi:"messageFormat"`
	// (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
	MetricCompartmentId pulumi.StringOutput `pulumi:"metricCompartmentId"`
	// (Updatable) When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.  Example: `true`
	MetricCompartmentIdInSubtree pulumi.BoolOutput `pulumi:"metricCompartmentIdInSubtree"`
	// (Updatable) The source service or application emitting the metric that is evaluated by the alarm.  Example: `ociComputeagent`
	Namespace pulumi.StringOutput `pulumi:"namespace"`
	// (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
	//
	// The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
	//
	// Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING".
	//
	// The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.
	//
	// Example: `PT5M`
	PendingDuration pulumi.StringOutput `pulumi:"pendingDuration"`
	// (Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	//
	// Example of threshold alarm:
	//
	// ***
	//
	// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85
	//
	// ***
	//
	// Example of absence alarm:
	//
	// ***
	//
	// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
	//
	// ***
	Query pulumi.StringOutput `pulumi:"query"`
	// (Updatable) The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.
	//
	// Default value: null (notifications are not re-submitted).
	//
	// Example: `PT2H`
	RepeatNotificationDuration pulumi.StringOutput `pulumi:"repeatNotificationDuration"`
	// (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m`
	Resolution pulumi.StringOutput `pulumi:"resolution"`
	// (Updatable) Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Avoid entering confidential information.  Example: `frontend-fleet`
	ResourceGroup pulumi.StringOutput `pulumi:"resourceGroup"`
	// (Updatable) The perceived type of response required when the alarm is in the "FIRING" state.  Example: `CRITICAL`
	Severity pulumi.StringOutput `pulumi:"severity"`
	// The current lifecycle state of the alarm.  Example: `DELETED`
	State pulumi.StringOutput `pulumi:"state"`
	// (Updatable) The configuration details for suppressing an alarm.
	Suppression AlarmSuppressionOutput `pulumi:"suppression"`
	// The date and time the alarm was created. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeCreated pulumi.StringOutput `pulumi:"timeCreated"`
	// The date and time the alarm was last updated. Format defined by RFC3339.  Example: `2019-02-03T01:02:29.600Z`
	TimeUpdated pulumi.StringOutput `pulumi:"timeUpdated"`
}

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

Creates a new alarm in the specified compartment. For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).

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

```go 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.NewAlarm(ctx, "testAlarm", &Monitoring.AlarmArgs{
			CompartmentId: pulumi.Any(_var.Compartment_id),
			Destinations: pulumi.StringArray{
				oci_ons_notification_topic.Test_notification_topic.Id,
			},
			DisplayName:         pulumi.Any(_var.Alarm_display_name),
			IsEnabled:           pulumi.Any(_var.Alarm_is_enabled),
			MetricCompartmentId: pulumi.Any(_var.Alarm_metric_compartment_id),
			Namespace:           pulumi.Any(_var.Alarm_namespace),
			Query:               pulumi.Any(_var.Alarm_query),
			Severity:            pulumi.Any(_var.Alarm_severity),
			Body:                pulumi.Any(_var.Alarm_body),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			IsNotificationsPerMetricDimensionEnabled: pulumi.Any(_var.Alarm_is_notifications_per_metric_dimension_enabled),
			MessageFormat:                            pulumi.Any(_var.Alarm_message_format),
			MetricCompartmentIdInSubtree:             pulumi.Any(_var.Alarm_metric_compartment_id_in_subtree),
			PendingDuration:                          pulumi.Any(_var.Alarm_pending_duration),
			RepeatNotificationDuration:               pulumi.Any(_var.Alarm_repeat_notification_duration),
			Resolution:                               pulumi.Any(_var.Alarm_resolution),
			ResourceGroup:                            pulumi.Any(_var.Alarm_resource_group),
			Suppression: &monitoring.AlarmSuppressionArgs{
				TimeSuppressFrom:  pulumi.Any(_var.Alarm_suppression_time_suppress_from),
				TimeSuppressUntil: pulumi.Any(_var.Alarm_suppression_time_suppress_until),
				Description:       pulumi.Any(_var.Alarm_suppression_description),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Alarms can be imported using the `id`, e.g.

```sh

$ pulumi import oci:Monitoring/alarm:Alarm test_alarm "id"

```

func GetAlarm

func GetAlarm(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AlarmState, opts ...pulumi.ResourceOption) (*Alarm, error)

GetAlarm gets an existing Alarm resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewAlarm

func NewAlarm(ctx *pulumi.Context,
	name string, args *AlarmArgs, opts ...pulumi.ResourceOption) (*Alarm, error)

NewAlarm registers a new resource with the given unique name, arguments, and options.

func (*Alarm) ElementType

func (*Alarm) ElementType() reflect.Type

func (*Alarm) ToAlarmOutput

func (i *Alarm) ToAlarmOutput() AlarmOutput

func (*Alarm) ToAlarmOutputWithContext

func (i *Alarm) ToAlarmOutputWithContext(ctx context.Context) AlarmOutput

type AlarmArgs

type AlarmArgs struct {
	// (Updatable) The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information.  Example: `High CPU usage alert. Follow runbook instructions for resolution.`
	Body pulumi.StringPtrInput
	// (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
	CompartmentId pulumi.StringInput
	// (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
	DefinedTags pulumi.MapInput
	// (Updatable) A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
	Destinations pulumi.StringArrayInput
	// (Updatable) A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	//
	// This name is sent as the title for notifications related to this alarm.
	//
	// Example: `High CPU Utilization`
	DisplayName pulumi.StringInput
	// (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
	FreeformTags pulumi.MapInput
	// (Updatable) Whether the alarm is enabled.  Example: `true`
	IsEnabled pulumi.BoolInput
	// (Updatable) When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`
	IsNotificationsPerMetricDimensionEnabled pulumi.BoolPtrInput
	// (Updatable) The format to use for notification messages sent from this alarm. The formats are:
	MessageFormat pulumi.StringPtrInput
	// (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
	MetricCompartmentId pulumi.StringInput
	// (Updatable) When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.  Example: `true`
	MetricCompartmentIdInSubtree pulumi.BoolPtrInput
	// (Updatable) The source service or application emitting the metric that is evaluated by the alarm.  Example: `ociComputeagent`
	Namespace pulumi.StringInput
	// (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
	//
	// The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
	//
	// Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING".
	//
	// The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.
	//
	// Example: `PT5M`
	PendingDuration pulumi.StringPtrInput
	// (Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	//
	// Example of threshold alarm:
	//
	// ***
	//
	// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85
	//
	// ***
	//
	// Example of absence alarm:
	//
	// ***
	//
	// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
	//
	// ***
	Query pulumi.StringInput
	// (Updatable) The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.
	//
	// Default value: null (notifications are not re-submitted).
	//
	// Example: `PT2H`
	RepeatNotificationDuration pulumi.StringPtrInput
	// (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m`
	Resolution pulumi.StringPtrInput
	// (Updatable) Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Avoid entering confidential information.  Example: `frontend-fleet`
	ResourceGroup pulumi.StringPtrInput
	// (Updatable) The perceived type of response required when the alarm is in the "FIRING" state.  Example: `CRITICAL`
	Severity pulumi.StringInput
	// (Updatable) The configuration details for suppressing an alarm.
	Suppression AlarmSuppressionPtrInput
}

The set of arguments for constructing a Alarm resource.

func (AlarmArgs) ElementType

func (AlarmArgs) ElementType() reflect.Type

type AlarmArray

type AlarmArray []AlarmInput

func (AlarmArray) ElementType

func (AlarmArray) ElementType() reflect.Type

func (AlarmArray) ToAlarmArrayOutput

func (i AlarmArray) ToAlarmArrayOutput() AlarmArrayOutput

func (AlarmArray) ToAlarmArrayOutputWithContext

func (i AlarmArray) ToAlarmArrayOutputWithContext(ctx context.Context) AlarmArrayOutput

type AlarmArrayInput

type AlarmArrayInput interface {
	pulumi.Input

	ToAlarmArrayOutput() AlarmArrayOutput
	ToAlarmArrayOutputWithContext(context.Context) AlarmArrayOutput
}

AlarmArrayInput is an input type that accepts AlarmArray and AlarmArrayOutput values. You can construct a concrete instance of `AlarmArrayInput` via:

AlarmArray{ AlarmArgs{...} }

type AlarmArrayOutput

type AlarmArrayOutput struct{ *pulumi.OutputState }

func (AlarmArrayOutput) ElementType

func (AlarmArrayOutput) ElementType() reflect.Type

func (AlarmArrayOutput) Index

func (AlarmArrayOutput) ToAlarmArrayOutput

func (o AlarmArrayOutput) ToAlarmArrayOutput() AlarmArrayOutput

func (AlarmArrayOutput) ToAlarmArrayOutputWithContext

func (o AlarmArrayOutput) ToAlarmArrayOutputWithContext(ctx context.Context) AlarmArrayOutput

type AlarmInput

type AlarmInput interface {
	pulumi.Input

	ToAlarmOutput() AlarmOutput
	ToAlarmOutputWithContext(ctx context.Context) AlarmOutput
}

type AlarmMap

type AlarmMap map[string]AlarmInput

func (AlarmMap) ElementType

func (AlarmMap) ElementType() reflect.Type

func (AlarmMap) ToAlarmMapOutput

func (i AlarmMap) ToAlarmMapOutput() AlarmMapOutput

func (AlarmMap) ToAlarmMapOutputWithContext

func (i AlarmMap) ToAlarmMapOutputWithContext(ctx context.Context) AlarmMapOutput

type AlarmMapInput

type AlarmMapInput interface {
	pulumi.Input

	ToAlarmMapOutput() AlarmMapOutput
	ToAlarmMapOutputWithContext(context.Context) AlarmMapOutput
}

AlarmMapInput is an input type that accepts AlarmMap and AlarmMapOutput values. You can construct a concrete instance of `AlarmMapInput` via:

AlarmMap{ "key": AlarmArgs{...} }

type AlarmMapOutput

type AlarmMapOutput struct{ *pulumi.OutputState }

func (AlarmMapOutput) ElementType

func (AlarmMapOutput) ElementType() reflect.Type

func (AlarmMapOutput) MapIndex

func (AlarmMapOutput) ToAlarmMapOutput

func (o AlarmMapOutput) ToAlarmMapOutput() AlarmMapOutput

func (AlarmMapOutput) ToAlarmMapOutputWithContext

func (o AlarmMapOutput) ToAlarmMapOutputWithContext(ctx context.Context) AlarmMapOutput

type AlarmOutput

type AlarmOutput struct{ *pulumi.OutputState }

func (AlarmOutput) Body added in v0.4.0

func (o AlarmOutput) Body() pulumi.StringOutput

(Updatable) The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`

func (AlarmOutput) CompartmentId added in v0.4.0

func (o AlarmOutput) CompartmentId() pulumi.StringOutput

(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.

func (AlarmOutput) DefinedTags added in v0.4.0

func (o AlarmOutput) DefinedTags() pulumi.MapOutput

(Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`

func (AlarmOutput) Destinations added in v0.4.0

func (o AlarmOutput) Destinations() pulumi.StringArrayOutput

(Updatable) A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.

func (AlarmOutput) DisplayName added in v0.4.0

func (o AlarmOutput) DisplayName() pulumi.StringOutput

(Updatable) A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information.

This name is sent as the title for notifications related to this alarm.

Example: `High CPU Utilization`

func (AlarmOutput) ElementType

func (AlarmOutput) ElementType() reflect.Type

func (AlarmOutput) FreeformTags added in v0.4.0

func (o AlarmOutput) FreeformTags() pulumi.MapOutput

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`

func (AlarmOutput) IsEnabled added in v0.4.0

func (o AlarmOutput) IsEnabled() pulumi.BoolOutput

(Updatable) Whether the alarm is enabled. Example: `true`

func (AlarmOutput) IsNotificationsPerMetricDimensionEnabled added in v0.5.0

func (o AlarmOutput) IsNotificationsPerMetricDimensionEnabled() pulumi.BoolOutput

(Updatable) When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`

func (AlarmOutput) MessageFormat added in v0.4.0

func (o AlarmOutput) MessageFormat() pulumi.StringOutput

(Updatable) The format to use for notification messages sent from this alarm. The formats are:

func (AlarmOutput) MetricCompartmentId added in v0.4.0

func (o AlarmOutput) MetricCompartmentId() pulumi.StringOutput

(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.

func (AlarmOutput) MetricCompartmentIdInSubtree added in v0.4.0

func (o AlarmOutput) MetricCompartmentIdInSubtree() pulumi.BoolOutput

(Updatable) When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: `true`

func (AlarmOutput) Namespace added in v0.4.0

func (o AlarmOutput) Namespace() pulumi.StringOutput

(Updatable) The source service or application emitting the metric that is evaluated by the alarm. Example: `ociComputeagent`

func (AlarmOutput) PendingDuration added in v0.4.0

func (o AlarmOutput) PendingDuration() pulumi.StringOutput

(Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".

The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.

Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING".

The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.

Example: `PT5M`

func (AlarmOutput) Query added in v0.4.0

func (o AlarmOutput) Query() pulumi.StringOutput

(Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).

Example of threshold alarm:

***

CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85

***

Example of absence alarm:

***

CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()

***

func (AlarmOutput) RepeatNotificationDuration added in v0.4.0

func (o AlarmOutput) RepeatNotificationDuration() pulumi.StringOutput

(Updatable) The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.

Default value: null (notifications are not re-submitted).

Example: `PT2H`

func (AlarmOutput) Resolution added in v0.4.0

func (o AlarmOutput) Resolution() pulumi.StringOutput

(Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m`

func (AlarmOutput) ResourceGroup added in v0.4.0

func (o AlarmOutput) ResourceGroup() pulumi.StringOutput

(Updatable) Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Avoid entering confidential information. Example: `frontend-fleet`

func (AlarmOutput) Severity added in v0.4.0

func (o AlarmOutput) Severity() pulumi.StringOutput

(Updatable) The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`

func (AlarmOutput) State added in v0.4.0

func (o AlarmOutput) State() pulumi.StringOutput

The current lifecycle state of the alarm. Example: `DELETED`

func (AlarmOutput) Suppression added in v0.4.0

func (o AlarmOutput) Suppression() AlarmSuppressionOutput

(Updatable) The configuration details for suppressing an alarm.

func (AlarmOutput) TimeCreated added in v0.4.0

func (o AlarmOutput) TimeCreated() pulumi.StringOutput

The date and time the alarm was created. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (AlarmOutput) TimeUpdated added in v0.4.0

func (o AlarmOutput) TimeUpdated() pulumi.StringOutput

The date and time the alarm was last updated. Format defined by RFC3339. Example: `2019-02-03T01:02:29.600Z`

func (AlarmOutput) ToAlarmOutput

func (o AlarmOutput) ToAlarmOutput() AlarmOutput

func (AlarmOutput) ToAlarmOutputWithContext

func (o AlarmOutput) ToAlarmOutputWithContext(ctx context.Context) AlarmOutput

type AlarmState

type AlarmState struct {
	// (Updatable) The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information.  Example: `High CPU usage alert. Follow runbook instructions for resolution.`
	Body pulumi.StringPtrInput
	// (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
	CompartmentId pulumi.StringPtrInput
	// (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
	DefinedTags pulumi.MapInput
	// (Updatable) A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
	Destinations pulumi.StringArrayInput
	// (Updatable) A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	//
	// This name is sent as the title for notifications related to this alarm.
	//
	// Example: `High CPU Utilization`
	DisplayName pulumi.StringPtrInput
	// (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
	FreeformTags pulumi.MapInput
	// (Updatable) Whether the alarm is enabled.  Example: `true`
	IsEnabled pulumi.BoolPtrInput
	// (Updatable) When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`
	IsNotificationsPerMetricDimensionEnabled pulumi.BoolPtrInput
	// (Updatable) The format to use for notification messages sent from this alarm. The formats are:
	MessageFormat pulumi.StringPtrInput
	// (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
	MetricCompartmentId pulumi.StringPtrInput
	// (Updatable) When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.  Example: `true`
	MetricCompartmentIdInSubtree pulumi.BoolPtrInput
	// (Updatable) The source service or application emitting the metric that is evaluated by the alarm.  Example: `ociComputeagent`
	Namespace pulumi.StringPtrInput
	// (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
	//
	// The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
	//
	// Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING".
	//
	// The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.
	//
	// Example: `PT5M`
	PendingDuration pulumi.StringPtrInput
	// (Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	//
	// Example of threshold alarm:
	//
	// ***
	//
	// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85
	//
	// ***
	//
	// Example of absence alarm:
	//
	// ***
	//
	// CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
	//
	// ***
	Query pulumi.StringPtrInput
	// (Updatable) The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.
	//
	// Default value: null (notifications are not re-submitted).
	//
	// Example: `PT2H`
	RepeatNotificationDuration pulumi.StringPtrInput
	// (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m`
	Resolution pulumi.StringPtrInput
	// (Updatable) Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Avoid entering confidential information.  Example: `frontend-fleet`
	ResourceGroup pulumi.StringPtrInput
	// (Updatable) The perceived type of response required when the alarm is in the "FIRING" state.  Example: `CRITICAL`
	Severity pulumi.StringPtrInput
	// The current lifecycle state of the alarm.  Example: `DELETED`
	State pulumi.StringPtrInput
	// (Updatable) The configuration details for suppressing an alarm.
	Suppression AlarmSuppressionPtrInput
	// The date and time the alarm was created. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeCreated pulumi.StringPtrInput
	// The date and time the alarm was last updated. Format defined by RFC3339.  Example: `2019-02-03T01:02:29.600Z`
	TimeUpdated pulumi.StringPtrInput
}

func (AlarmState) ElementType

func (AlarmState) ElementType() reflect.Type

type AlarmSuppression

type AlarmSuppression struct {
	// (Updatable) Human-readable reason for suppressing alarm notifications. 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.`
	Description *string `pulumi:"description"`
	// (Updatable) The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeSuppressFrom string `pulumi:"timeSuppressFrom"`
	// (Updatable) The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-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
	TimeSuppressUntil string `pulumi:"timeSuppressUntil"`
}

type AlarmSuppressionArgs

type AlarmSuppressionArgs struct {
	// (Updatable) Human-readable reason for suppressing alarm notifications. 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.`
	Description pulumi.StringPtrInput `pulumi:"description"`
	// (Updatable) The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeSuppressFrom pulumi.StringInput `pulumi:"timeSuppressFrom"`
	// (Updatable) The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-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
	TimeSuppressUntil pulumi.StringInput `pulumi:"timeSuppressUntil"`
}

func (AlarmSuppressionArgs) ElementType

func (AlarmSuppressionArgs) ElementType() reflect.Type

func (AlarmSuppressionArgs) ToAlarmSuppressionOutput

func (i AlarmSuppressionArgs) ToAlarmSuppressionOutput() AlarmSuppressionOutput

func (AlarmSuppressionArgs) ToAlarmSuppressionOutputWithContext

func (i AlarmSuppressionArgs) ToAlarmSuppressionOutputWithContext(ctx context.Context) AlarmSuppressionOutput

func (AlarmSuppressionArgs) ToAlarmSuppressionPtrOutput

func (i AlarmSuppressionArgs) ToAlarmSuppressionPtrOutput() AlarmSuppressionPtrOutput

func (AlarmSuppressionArgs) ToAlarmSuppressionPtrOutputWithContext

func (i AlarmSuppressionArgs) ToAlarmSuppressionPtrOutputWithContext(ctx context.Context) AlarmSuppressionPtrOutput

type AlarmSuppressionInput

type AlarmSuppressionInput interface {
	pulumi.Input

	ToAlarmSuppressionOutput() AlarmSuppressionOutput
	ToAlarmSuppressionOutputWithContext(context.Context) AlarmSuppressionOutput
}

AlarmSuppressionInput is an input type that accepts AlarmSuppressionArgs and AlarmSuppressionOutput values. You can construct a concrete instance of `AlarmSuppressionInput` via:

AlarmSuppressionArgs{...}

type AlarmSuppressionOutput

type AlarmSuppressionOutput struct{ *pulumi.OutputState }

func (AlarmSuppressionOutput) Description

(Updatable) Human-readable reason for suppressing alarm notifications. 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.`

func (AlarmSuppressionOutput) ElementType

func (AlarmSuppressionOutput) ElementType() reflect.Type

func (AlarmSuppressionOutput) TimeSuppressFrom

func (o AlarmSuppressionOutput) TimeSuppressFrom() pulumi.StringOutput

(Updatable) The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (AlarmSuppressionOutput) TimeSuppressUntil

func (o AlarmSuppressionOutput) TimeSuppressUntil() pulumi.StringOutput

(Updatable) The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-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

func (AlarmSuppressionOutput) ToAlarmSuppressionOutput

func (o AlarmSuppressionOutput) ToAlarmSuppressionOutput() AlarmSuppressionOutput

func (AlarmSuppressionOutput) ToAlarmSuppressionOutputWithContext

func (o AlarmSuppressionOutput) ToAlarmSuppressionOutputWithContext(ctx context.Context) AlarmSuppressionOutput

func (AlarmSuppressionOutput) ToAlarmSuppressionPtrOutput

func (o AlarmSuppressionOutput) ToAlarmSuppressionPtrOutput() AlarmSuppressionPtrOutput

func (AlarmSuppressionOutput) ToAlarmSuppressionPtrOutputWithContext

func (o AlarmSuppressionOutput) ToAlarmSuppressionPtrOutputWithContext(ctx context.Context) AlarmSuppressionPtrOutput

type AlarmSuppressionPtrInput

type AlarmSuppressionPtrInput interface {
	pulumi.Input

	ToAlarmSuppressionPtrOutput() AlarmSuppressionPtrOutput
	ToAlarmSuppressionPtrOutputWithContext(context.Context) AlarmSuppressionPtrOutput
}

AlarmSuppressionPtrInput is an input type that accepts AlarmSuppressionArgs, AlarmSuppressionPtr and AlarmSuppressionPtrOutput values. You can construct a concrete instance of `AlarmSuppressionPtrInput` via:

        AlarmSuppressionArgs{...}

or:

        nil

type AlarmSuppressionPtrOutput

type AlarmSuppressionPtrOutput struct{ *pulumi.OutputState }

func (AlarmSuppressionPtrOutput) Description

(Updatable) Human-readable reason for suppressing alarm notifications. 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.`

func (AlarmSuppressionPtrOutput) Elem

func (AlarmSuppressionPtrOutput) ElementType

func (AlarmSuppressionPtrOutput) ElementType() reflect.Type

func (AlarmSuppressionPtrOutput) TimeSuppressFrom

func (o AlarmSuppressionPtrOutput) TimeSuppressFrom() pulumi.StringPtrOutput

(Updatable) The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (AlarmSuppressionPtrOutput) TimeSuppressUntil

func (o AlarmSuppressionPtrOutput) TimeSuppressUntil() pulumi.StringPtrOutput

(Updatable) The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-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

func (AlarmSuppressionPtrOutput) ToAlarmSuppressionPtrOutput

func (o AlarmSuppressionPtrOutput) ToAlarmSuppressionPtrOutput() AlarmSuppressionPtrOutput

func (AlarmSuppressionPtrOutput) ToAlarmSuppressionPtrOutputWithContext

func (o AlarmSuppressionPtrOutput) ToAlarmSuppressionPtrOutputWithContext(ctx context.Context) AlarmSuppressionPtrOutput

type GetAlarmHistoryCollectionArgs

type GetAlarmHistoryCollectionArgs struct {
	// The type of history entries to retrieve. State history (STATE_HISTORY) or state transition history (STATE_TRANSITION_HISTORY). If not specified, entries of both types are retrieved.  Example: `STATE_HISTORY`
	AlarmHistorytype *string `pulumi:"alarmHistorytype"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
	AlarmId string `pulumi:"alarmId"`
	// A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.  Example: `2019-01-01T01:00:00.789Z`
	TimestampGreaterThanOrEqualTo *string `pulumi:"timestampGreaterThanOrEqualTo"`
	// A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.  Example: `2019-01-02T01:00:00.789Z`
	TimestampLessThan *string `pulumi:"timestampLessThan"`
}

A collection of arguments for invoking getAlarmHistoryCollection.

type GetAlarmHistoryCollectionEntry

type GetAlarmHistoryCollectionEntry struct {
	// Description for this alarm history entry.
	Summary string `pulumi:"summary"`
	// Timestamp for this alarm history entry. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	Timestamp string `pulumi:"timestamp"`
	// Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics.  Example: `2019-02-01T0:59:00.789Z`
	TimestampTriggered string `pulumi:"timestampTriggered"`
}

type GetAlarmHistoryCollectionEntryArgs

type GetAlarmHistoryCollectionEntryArgs struct {
	// Description for this alarm history entry.
	Summary pulumi.StringInput `pulumi:"summary"`
	// Timestamp for this alarm history entry. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	Timestamp pulumi.StringInput `pulumi:"timestamp"`
	// Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics.  Example: `2019-02-01T0:59:00.789Z`
	TimestampTriggered pulumi.StringInput `pulumi:"timestampTriggered"`
}

func (GetAlarmHistoryCollectionEntryArgs) ElementType

func (GetAlarmHistoryCollectionEntryArgs) ToGetAlarmHistoryCollectionEntryOutput

func (i GetAlarmHistoryCollectionEntryArgs) ToGetAlarmHistoryCollectionEntryOutput() GetAlarmHistoryCollectionEntryOutput

func (GetAlarmHistoryCollectionEntryArgs) ToGetAlarmHistoryCollectionEntryOutputWithContext

func (i GetAlarmHistoryCollectionEntryArgs) ToGetAlarmHistoryCollectionEntryOutputWithContext(ctx context.Context) GetAlarmHistoryCollectionEntryOutput

type GetAlarmHistoryCollectionEntryArray

type GetAlarmHistoryCollectionEntryArray []GetAlarmHistoryCollectionEntryInput

func (GetAlarmHistoryCollectionEntryArray) ElementType

func (GetAlarmHistoryCollectionEntryArray) ToGetAlarmHistoryCollectionEntryArrayOutput

func (i GetAlarmHistoryCollectionEntryArray) ToGetAlarmHistoryCollectionEntryArrayOutput() GetAlarmHistoryCollectionEntryArrayOutput

func (GetAlarmHistoryCollectionEntryArray) ToGetAlarmHistoryCollectionEntryArrayOutputWithContext

func (i GetAlarmHistoryCollectionEntryArray) ToGetAlarmHistoryCollectionEntryArrayOutputWithContext(ctx context.Context) GetAlarmHistoryCollectionEntryArrayOutput

type GetAlarmHistoryCollectionEntryArrayInput

type GetAlarmHistoryCollectionEntryArrayInput interface {
	pulumi.Input

	ToGetAlarmHistoryCollectionEntryArrayOutput() GetAlarmHistoryCollectionEntryArrayOutput
	ToGetAlarmHistoryCollectionEntryArrayOutputWithContext(context.Context) GetAlarmHistoryCollectionEntryArrayOutput
}

GetAlarmHistoryCollectionEntryArrayInput is an input type that accepts GetAlarmHistoryCollectionEntryArray and GetAlarmHistoryCollectionEntryArrayOutput values. You can construct a concrete instance of `GetAlarmHistoryCollectionEntryArrayInput` via:

GetAlarmHistoryCollectionEntryArray{ GetAlarmHistoryCollectionEntryArgs{...} }

type GetAlarmHistoryCollectionEntryArrayOutput

type GetAlarmHistoryCollectionEntryArrayOutput struct{ *pulumi.OutputState }

func (GetAlarmHistoryCollectionEntryArrayOutput) ElementType

func (GetAlarmHistoryCollectionEntryArrayOutput) Index

func (GetAlarmHistoryCollectionEntryArrayOutput) ToGetAlarmHistoryCollectionEntryArrayOutput

func (o GetAlarmHistoryCollectionEntryArrayOutput) ToGetAlarmHistoryCollectionEntryArrayOutput() GetAlarmHistoryCollectionEntryArrayOutput

func (GetAlarmHistoryCollectionEntryArrayOutput) ToGetAlarmHistoryCollectionEntryArrayOutputWithContext

func (o GetAlarmHistoryCollectionEntryArrayOutput) ToGetAlarmHistoryCollectionEntryArrayOutputWithContext(ctx context.Context) GetAlarmHistoryCollectionEntryArrayOutput

type GetAlarmHistoryCollectionEntryInput

type GetAlarmHistoryCollectionEntryInput interface {
	pulumi.Input

	ToGetAlarmHistoryCollectionEntryOutput() GetAlarmHistoryCollectionEntryOutput
	ToGetAlarmHistoryCollectionEntryOutputWithContext(context.Context) GetAlarmHistoryCollectionEntryOutput
}

GetAlarmHistoryCollectionEntryInput is an input type that accepts GetAlarmHistoryCollectionEntryArgs and GetAlarmHistoryCollectionEntryOutput values. You can construct a concrete instance of `GetAlarmHistoryCollectionEntryInput` via:

GetAlarmHistoryCollectionEntryArgs{...}

type GetAlarmHistoryCollectionEntryOutput

type GetAlarmHistoryCollectionEntryOutput struct{ *pulumi.OutputState }

func (GetAlarmHistoryCollectionEntryOutput) ElementType

func (GetAlarmHistoryCollectionEntryOutput) Summary

Description for this alarm history entry.

func (GetAlarmHistoryCollectionEntryOutput) Timestamp

Timestamp for this alarm history entry. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (GetAlarmHistoryCollectionEntryOutput) TimestampTriggered

Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2019-02-01T0:59:00.789Z`

func (GetAlarmHistoryCollectionEntryOutput) ToGetAlarmHistoryCollectionEntryOutput

func (o GetAlarmHistoryCollectionEntryOutput) ToGetAlarmHistoryCollectionEntryOutput() GetAlarmHistoryCollectionEntryOutput

func (GetAlarmHistoryCollectionEntryOutput) ToGetAlarmHistoryCollectionEntryOutputWithContext

func (o GetAlarmHistoryCollectionEntryOutput) ToGetAlarmHistoryCollectionEntryOutputWithContext(ctx context.Context) GetAlarmHistoryCollectionEntryOutput

type GetAlarmHistoryCollectionOutputArgs

type GetAlarmHistoryCollectionOutputArgs struct {
	// The type of history entries to retrieve. State history (STATE_HISTORY) or state transition history (STATE_TRANSITION_HISTORY). If not specified, entries of both types are retrieved.  Example: `STATE_HISTORY`
	AlarmHistorytype pulumi.StringPtrInput `pulumi:"alarmHistorytype"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
	AlarmId pulumi.StringInput `pulumi:"alarmId"`
	// A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.  Example: `2019-01-01T01:00:00.789Z`
	TimestampGreaterThanOrEqualTo pulumi.StringPtrInput `pulumi:"timestampGreaterThanOrEqualTo"`
	// A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.  Example: `2019-01-02T01:00:00.789Z`
	TimestampLessThan pulumi.StringPtrInput `pulumi:"timestampLessThan"`
}

A collection of arguments for invoking getAlarmHistoryCollection.

func (GetAlarmHistoryCollectionOutputArgs) ElementType

type GetAlarmHistoryCollectionResult

type GetAlarmHistoryCollectionResult struct {
	AlarmHistorytype *string `pulumi:"alarmHistorytype"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm for which to retrieve history.
	AlarmId string `pulumi:"alarmId"`
	// The set of history entries retrieved for the alarm.
	Entries []GetAlarmHistoryCollectionEntry `pulumi:"entries"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// Whether the alarm is enabled.  Example: `true`
	IsEnabled                     bool    `pulumi:"isEnabled"`
	TimestampGreaterThanOrEqualTo *string `pulumi:"timestampGreaterThanOrEqualTo"`
	TimestampLessThan             *string `pulumi:"timestampLessThan"`
}

A collection of values returned by getAlarmHistoryCollection.

func GetAlarmHistoryCollection

func GetAlarmHistoryCollection(ctx *pulumi.Context, args *GetAlarmHistoryCollectionArgs, opts ...pulumi.InvokeOption) (*GetAlarmHistoryCollectionResult, error)

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

Get the history of the specified alarm. For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).

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

```go 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.GetAlarmHistoryCollection(ctx, &monitoring.GetAlarmHistoryCollectionArgs{
			AlarmId:                       oci_monitoring_alarm.Test_alarm.Id,
			AlarmHistorytype:              pulumi.StringRef(_var.Alarm_history_collection_alarm_historytype),
			TimestampGreaterThanOrEqualTo: pulumi.StringRef(_var.Alarm_history_collection_timestamp_greater_than_or_equal_to),
			TimestampLessThan:             pulumi.StringRef(_var.Alarm_history_collection_timestamp_less_than),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetAlarmHistoryCollectionResultOutput

type GetAlarmHistoryCollectionResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAlarmHistoryCollection.

func (GetAlarmHistoryCollectionResultOutput) AlarmHistorytype

func (GetAlarmHistoryCollectionResultOutput) AlarmId

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm for which to retrieve history.

func (GetAlarmHistoryCollectionResultOutput) ElementType

func (GetAlarmHistoryCollectionResultOutput) Entries

The set of history entries retrieved for the alarm.

func (GetAlarmHistoryCollectionResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetAlarmHistoryCollectionResultOutput) IsEnabled

Whether the alarm is enabled. Example: `true`

func (GetAlarmHistoryCollectionResultOutput) TimestampGreaterThanOrEqualTo

func (o GetAlarmHistoryCollectionResultOutput) TimestampGreaterThanOrEqualTo() pulumi.StringPtrOutput

func (GetAlarmHistoryCollectionResultOutput) TimestampLessThan

func (GetAlarmHistoryCollectionResultOutput) ToGetAlarmHistoryCollectionResultOutput

func (o GetAlarmHistoryCollectionResultOutput) ToGetAlarmHistoryCollectionResultOutput() GetAlarmHistoryCollectionResultOutput

func (GetAlarmHistoryCollectionResultOutput) ToGetAlarmHistoryCollectionResultOutputWithContext

func (o GetAlarmHistoryCollectionResultOutput) ToGetAlarmHistoryCollectionResultOutputWithContext(ctx context.Context) GetAlarmHistoryCollectionResultOutput

type GetAlarmStatusesAlarmStatus

type GetAlarmStatusesAlarmStatus struct {
	// A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
	DisplayName string `pulumi:"displayName"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
	Id string `pulumi:"id"`
	// The configured severity of the alarm.  Example: `CRITICAL`
	Severity string `pulumi:"severity"`
	// The status of this alarm.  Example: `FIRING`
	Status string `pulumi:"status"`
	// The configuration details for suppressing an alarm.
	Suppressions []GetAlarmStatusesAlarmStatusSuppression `pulumi:"suppressions"`
	// Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics.  Example: `2019-02-01T01:02:29.600Z`
	TimestampTriggered string `pulumi:"timestampTriggered"`
}

type GetAlarmStatusesAlarmStatusArgs

type GetAlarmStatusesAlarmStatusArgs struct {
	// A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
	Id pulumi.StringInput `pulumi:"id"`
	// The configured severity of the alarm.  Example: `CRITICAL`
	Severity pulumi.StringInput `pulumi:"severity"`
	// The status of this alarm.  Example: `FIRING`
	Status pulumi.StringInput `pulumi:"status"`
	// The configuration details for suppressing an alarm.
	Suppressions GetAlarmStatusesAlarmStatusSuppressionArrayInput `pulumi:"suppressions"`
	// Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics.  Example: `2019-02-01T01:02:29.600Z`
	TimestampTriggered pulumi.StringInput `pulumi:"timestampTriggered"`
}

func (GetAlarmStatusesAlarmStatusArgs) ElementType

func (GetAlarmStatusesAlarmStatusArgs) ToGetAlarmStatusesAlarmStatusOutput

func (i GetAlarmStatusesAlarmStatusArgs) ToGetAlarmStatusesAlarmStatusOutput() GetAlarmStatusesAlarmStatusOutput

func (GetAlarmStatusesAlarmStatusArgs) ToGetAlarmStatusesAlarmStatusOutputWithContext

func (i GetAlarmStatusesAlarmStatusArgs) ToGetAlarmStatusesAlarmStatusOutputWithContext(ctx context.Context) GetAlarmStatusesAlarmStatusOutput

type GetAlarmStatusesAlarmStatusArray

type GetAlarmStatusesAlarmStatusArray []GetAlarmStatusesAlarmStatusInput

func (GetAlarmStatusesAlarmStatusArray) ElementType

func (GetAlarmStatusesAlarmStatusArray) ToGetAlarmStatusesAlarmStatusArrayOutput

func (i GetAlarmStatusesAlarmStatusArray) ToGetAlarmStatusesAlarmStatusArrayOutput() GetAlarmStatusesAlarmStatusArrayOutput

func (GetAlarmStatusesAlarmStatusArray) ToGetAlarmStatusesAlarmStatusArrayOutputWithContext

func (i GetAlarmStatusesAlarmStatusArray) ToGetAlarmStatusesAlarmStatusArrayOutputWithContext(ctx context.Context) GetAlarmStatusesAlarmStatusArrayOutput

type GetAlarmStatusesAlarmStatusArrayInput

type GetAlarmStatusesAlarmStatusArrayInput interface {
	pulumi.Input

	ToGetAlarmStatusesAlarmStatusArrayOutput() GetAlarmStatusesAlarmStatusArrayOutput
	ToGetAlarmStatusesAlarmStatusArrayOutputWithContext(context.Context) GetAlarmStatusesAlarmStatusArrayOutput
}

GetAlarmStatusesAlarmStatusArrayInput is an input type that accepts GetAlarmStatusesAlarmStatusArray and GetAlarmStatusesAlarmStatusArrayOutput values. You can construct a concrete instance of `GetAlarmStatusesAlarmStatusArrayInput` via:

GetAlarmStatusesAlarmStatusArray{ GetAlarmStatusesAlarmStatusArgs{...} }

type GetAlarmStatusesAlarmStatusArrayOutput

type GetAlarmStatusesAlarmStatusArrayOutput struct{ *pulumi.OutputState }

func (GetAlarmStatusesAlarmStatusArrayOutput) ElementType

func (GetAlarmStatusesAlarmStatusArrayOutput) Index

func (GetAlarmStatusesAlarmStatusArrayOutput) ToGetAlarmStatusesAlarmStatusArrayOutput

func (o GetAlarmStatusesAlarmStatusArrayOutput) ToGetAlarmStatusesAlarmStatusArrayOutput() GetAlarmStatusesAlarmStatusArrayOutput

func (GetAlarmStatusesAlarmStatusArrayOutput) ToGetAlarmStatusesAlarmStatusArrayOutputWithContext

func (o GetAlarmStatusesAlarmStatusArrayOutput) ToGetAlarmStatusesAlarmStatusArrayOutputWithContext(ctx context.Context) GetAlarmStatusesAlarmStatusArrayOutput

type GetAlarmStatusesAlarmStatusInput

type GetAlarmStatusesAlarmStatusInput interface {
	pulumi.Input

	ToGetAlarmStatusesAlarmStatusOutput() GetAlarmStatusesAlarmStatusOutput
	ToGetAlarmStatusesAlarmStatusOutputWithContext(context.Context) GetAlarmStatusesAlarmStatusOutput
}

GetAlarmStatusesAlarmStatusInput is an input type that accepts GetAlarmStatusesAlarmStatusArgs and GetAlarmStatusesAlarmStatusOutput values. You can construct a concrete instance of `GetAlarmStatusesAlarmStatusInput` via:

GetAlarmStatusesAlarmStatusArgs{...}

type GetAlarmStatusesAlarmStatusOutput

type GetAlarmStatusesAlarmStatusOutput struct{ *pulumi.OutputState }

func (GetAlarmStatusesAlarmStatusOutput) DisplayName

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

func (GetAlarmStatusesAlarmStatusOutput) ElementType

func (GetAlarmStatusesAlarmStatusOutput) Id

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.

func (GetAlarmStatusesAlarmStatusOutput) Severity

The configured severity of the alarm. Example: `CRITICAL`

func (GetAlarmStatusesAlarmStatusOutput) Status

The status of this alarm. Example: `FIRING`

func (GetAlarmStatusesAlarmStatusOutput) Suppressions

The configuration details for suppressing an alarm.

func (GetAlarmStatusesAlarmStatusOutput) TimestampTriggered

func (o GetAlarmStatusesAlarmStatusOutput) TimestampTriggered() pulumi.StringOutput

Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2019-02-01T01:02:29.600Z`

func (GetAlarmStatusesAlarmStatusOutput) ToGetAlarmStatusesAlarmStatusOutput

func (o GetAlarmStatusesAlarmStatusOutput) ToGetAlarmStatusesAlarmStatusOutput() GetAlarmStatusesAlarmStatusOutput

func (GetAlarmStatusesAlarmStatusOutput) ToGetAlarmStatusesAlarmStatusOutputWithContext

func (o GetAlarmStatusesAlarmStatusOutput) ToGetAlarmStatusesAlarmStatusOutputWithContext(ctx context.Context) GetAlarmStatusesAlarmStatusOutput

type GetAlarmStatusesAlarmStatusSuppression

type GetAlarmStatusesAlarmStatusSuppression struct {
	// Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	Description string `pulumi:"description"`
	// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeSuppressFrom string `pulumi:"timeSuppressFrom"`
	// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T02:02:29.600Z`
	TimeSuppressUntil string `pulumi:"timeSuppressUntil"`
}

type GetAlarmStatusesAlarmStatusSuppressionArgs

type GetAlarmStatusesAlarmStatusSuppressionArgs struct {
	// Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	Description pulumi.StringInput `pulumi:"description"`
	// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeSuppressFrom pulumi.StringInput `pulumi:"timeSuppressFrom"`
	// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T02:02:29.600Z`
	TimeSuppressUntil pulumi.StringInput `pulumi:"timeSuppressUntil"`
}

func (GetAlarmStatusesAlarmStatusSuppressionArgs) ElementType

func (GetAlarmStatusesAlarmStatusSuppressionArgs) ToGetAlarmStatusesAlarmStatusSuppressionOutput

func (i GetAlarmStatusesAlarmStatusSuppressionArgs) ToGetAlarmStatusesAlarmStatusSuppressionOutput() GetAlarmStatusesAlarmStatusSuppressionOutput

func (GetAlarmStatusesAlarmStatusSuppressionArgs) ToGetAlarmStatusesAlarmStatusSuppressionOutputWithContext

func (i GetAlarmStatusesAlarmStatusSuppressionArgs) ToGetAlarmStatusesAlarmStatusSuppressionOutputWithContext(ctx context.Context) GetAlarmStatusesAlarmStatusSuppressionOutput

type GetAlarmStatusesAlarmStatusSuppressionArray

type GetAlarmStatusesAlarmStatusSuppressionArray []GetAlarmStatusesAlarmStatusSuppressionInput

func (GetAlarmStatusesAlarmStatusSuppressionArray) ElementType

func (GetAlarmStatusesAlarmStatusSuppressionArray) ToGetAlarmStatusesAlarmStatusSuppressionArrayOutput

func (i GetAlarmStatusesAlarmStatusSuppressionArray) ToGetAlarmStatusesAlarmStatusSuppressionArrayOutput() GetAlarmStatusesAlarmStatusSuppressionArrayOutput

func (GetAlarmStatusesAlarmStatusSuppressionArray) ToGetAlarmStatusesAlarmStatusSuppressionArrayOutputWithContext

func (i GetAlarmStatusesAlarmStatusSuppressionArray) ToGetAlarmStatusesAlarmStatusSuppressionArrayOutputWithContext(ctx context.Context) GetAlarmStatusesAlarmStatusSuppressionArrayOutput

type GetAlarmStatusesAlarmStatusSuppressionArrayInput

type GetAlarmStatusesAlarmStatusSuppressionArrayInput interface {
	pulumi.Input

	ToGetAlarmStatusesAlarmStatusSuppressionArrayOutput() GetAlarmStatusesAlarmStatusSuppressionArrayOutput
	ToGetAlarmStatusesAlarmStatusSuppressionArrayOutputWithContext(context.Context) GetAlarmStatusesAlarmStatusSuppressionArrayOutput
}

GetAlarmStatusesAlarmStatusSuppressionArrayInput is an input type that accepts GetAlarmStatusesAlarmStatusSuppressionArray and GetAlarmStatusesAlarmStatusSuppressionArrayOutput values. You can construct a concrete instance of `GetAlarmStatusesAlarmStatusSuppressionArrayInput` via:

GetAlarmStatusesAlarmStatusSuppressionArray{ GetAlarmStatusesAlarmStatusSuppressionArgs{...} }

type GetAlarmStatusesAlarmStatusSuppressionArrayOutput

type GetAlarmStatusesAlarmStatusSuppressionArrayOutput struct{ *pulumi.OutputState }

func (GetAlarmStatusesAlarmStatusSuppressionArrayOutput) ElementType

func (GetAlarmStatusesAlarmStatusSuppressionArrayOutput) Index

func (GetAlarmStatusesAlarmStatusSuppressionArrayOutput) ToGetAlarmStatusesAlarmStatusSuppressionArrayOutput

func (o GetAlarmStatusesAlarmStatusSuppressionArrayOutput) ToGetAlarmStatusesAlarmStatusSuppressionArrayOutput() GetAlarmStatusesAlarmStatusSuppressionArrayOutput

func (GetAlarmStatusesAlarmStatusSuppressionArrayOutput) ToGetAlarmStatusesAlarmStatusSuppressionArrayOutputWithContext

func (o GetAlarmStatusesAlarmStatusSuppressionArrayOutput) ToGetAlarmStatusesAlarmStatusSuppressionArrayOutputWithContext(ctx context.Context) GetAlarmStatusesAlarmStatusSuppressionArrayOutput

type GetAlarmStatusesAlarmStatusSuppressionInput

type GetAlarmStatusesAlarmStatusSuppressionInput interface {
	pulumi.Input

	ToGetAlarmStatusesAlarmStatusSuppressionOutput() GetAlarmStatusesAlarmStatusSuppressionOutput
	ToGetAlarmStatusesAlarmStatusSuppressionOutputWithContext(context.Context) GetAlarmStatusesAlarmStatusSuppressionOutput
}

GetAlarmStatusesAlarmStatusSuppressionInput is an input type that accepts GetAlarmStatusesAlarmStatusSuppressionArgs and GetAlarmStatusesAlarmStatusSuppressionOutput values. You can construct a concrete instance of `GetAlarmStatusesAlarmStatusSuppressionInput` via:

GetAlarmStatusesAlarmStatusSuppressionArgs{...}

type GetAlarmStatusesAlarmStatusSuppressionOutput

type GetAlarmStatusesAlarmStatusSuppressionOutput struct{ *pulumi.OutputState }

func (GetAlarmStatusesAlarmStatusSuppressionOutput) Description

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

func (GetAlarmStatusesAlarmStatusSuppressionOutput) ElementType

func (GetAlarmStatusesAlarmStatusSuppressionOutput) TimeSuppressFrom

The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (GetAlarmStatusesAlarmStatusSuppressionOutput) TimeSuppressUntil

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

func (GetAlarmStatusesAlarmStatusSuppressionOutput) ToGetAlarmStatusesAlarmStatusSuppressionOutput

func (o GetAlarmStatusesAlarmStatusSuppressionOutput) ToGetAlarmStatusesAlarmStatusSuppressionOutput() GetAlarmStatusesAlarmStatusSuppressionOutput

func (GetAlarmStatusesAlarmStatusSuppressionOutput) ToGetAlarmStatusesAlarmStatusSuppressionOutputWithContext

func (o GetAlarmStatusesAlarmStatusSuppressionOutput) ToGetAlarmStatusesAlarmStatusSuppressionOutputWithContext(ctx context.Context) GetAlarmStatusesAlarmStatusSuppressionOutput

type GetAlarmStatusesArgs

type GetAlarmStatusesArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId string `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree *bool `pulumi:"compartmentIdInSubtree"`
	// A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
	DisplayName *string                  `pulumi:"displayName"`
	Filters     []GetAlarmStatusesFilter `pulumi:"filters"`
}

A collection of arguments for invoking getAlarmStatuses.

type GetAlarmStatusesFilter

type GetAlarmStatusesFilter struct {
	Name   string   `pulumi:"name"`
	Regex  *bool    `pulumi:"regex"`
	Values []string `pulumi:"values"`
}

type GetAlarmStatusesFilterArgs

type GetAlarmStatusesFilterArgs struct {
	Name   pulumi.StringInput      `pulumi:"name"`
	Regex  pulumi.BoolPtrInput     `pulumi:"regex"`
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GetAlarmStatusesFilterArgs) ElementType

func (GetAlarmStatusesFilterArgs) ElementType() reflect.Type

func (GetAlarmStatusesFilterArgs) ToGetAlarmStatusesFilterOutput

func (i GetAlarmStatusesFilterArgs) ToGetAlarmStatusesFilterOutput() GetAlarmStatusesFilterOutput

func (GetAlarmStatusesFilterArgs) ToGetAlarmStatusesFilterOutputWithContext

func (i GetAlarmStatusesFilterArgs) ToGetAlarmStatusesFilterOutputWithContext(ctx context.Context) GetAlarmStatusesFilterOutput

type GetAlarmStatusesFilterArray

type GetAlarmStatusesFilterArray []GetAlarmStatusesFilterInput

func (GetAlarmStatusesFilterArray) ElementType

func (GetAlarmStatusesFilterArray) ToGetAlarmStatusesFilterArrayOutput

func (i GetAlarmStatusesFilterArray) ToGetAlarmStatusesFilterArrayOutput() GetAlarmStatusesFilterArrayOutput

func (GetAlarmStatusesFilterArray) ToGetAlarmStatusesFilterArrayOutputWithContext

func (i GetAlarmStatusesFilterArray) ToGetAlarmStatusesFilterArrayOutputWithContext(ctx context.Context) GetAlarmStatusesFilterArrayOutput

type GetAlarmStatusesFilterArrayInput

type GetAlarmStatusesFilterArrayInput interface {
	pulumi.Input

	ToGetAlarmStatusesFilterArrayOutput() GetAlarmStatusesFilterArrayOutput
	ToGetAlarmStatusesFilterArrayOutputWithContext(context.Context) GetAlarmStatusesFilterArrayOutput
}

GetAlarmStatusesFilterArrayInput is an input type that accepts GetAlarmStatusesFilterArray and GetAlarmStatusesFilterArrayOutput values. You can construct a concrete instance of `GetAlarmStatusesFilterArrayInput` via:

GetAlarmStatusesFilterArray{ GetAlarmStatusesFilterArgs{...} }

type GetAlarmStatusesFilterArrayOutput

type GetAlarmStatusesFilterArrayOutput struct{ *pulumi.OutputState }

func (GetAlarmStatusesFilterArrayOutput) ElementType

func (GetAlarmStatusesFilterArrayOutput) Index

func (GetAlarmStatusesFilterArrayOutput) ToGetAlarmStatusesFilterArrayOutput

func (o GetAlarmStatusesFilterArrayOutput) ToGetAlarmStatusesFilterArrayOutput() GetAlarmStatusesFilterArrayOutput

func (GetAlarmStatusesFilterArrayOutput) ToGetAlarmStatusesFilterArrayOutputWithContext

func (o GetAlarmStatusesFilterArrayOutput) ToGetAlarmStatusesFilterArrayOutputWithContext(ctx context.Context) GetAlarmStatusesFilterArrayOutput

type GetAlarmStatusesFilterInput

type GetAlarmStatusesFilterInput interface {
	pulumi.Input

	ToGetAlarmStatusesFilterOutput() GetAlarmStatusesFilterOutput
	ToGetAlarmStatusesFilterOutputWithContext(context.Context) GetAlarmStatusesFilterOutput
}

GetAlarmStatusesFilterInput is an input type that accepts GetAlarmStatusesFilterArgs and GetAlarmStatusesFilterOutput values. You can construct a concrete instance of `GetAlarmStatusesFilterInput` via:

GetAlarmStatusesFilterArgs{...}

type GetAlarmStatusesFilterOutput

type GetAlarmStatusesFilterOutput struct{ *pulumi.OutputState }

func (GetAlarmStatusesFilterOutput) ElementType

func (GetAlarmStatusesFilterOutput) Name

func (GetAlarmStatusesFilterOutput) Regex

func (GetAlarmStatusesFilterOutput) ToGetAlarmStatusesFilterOutput

func (o GetAlarmStatusesFilterOutput) ToGetAlarmStatusesFilterOutput() GetAlarmStatusesFilterOutput

func (GetAlarmStatusesFilterOutput) ToGetAlarmStatusesFilterOutputWithContext

func (o GetAlarmStatusesFilterOutput) ToGetAlarmStatusesFilterOutputWithContext(ctx context.Context) GetAlarmStatusesFilterOutput

func (GetAlarmStatusesFilterOutput) Values

type GetAlarmStatusesOutputArgs

type GetAlarmStatusesOutputArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId pulumi.StringInput `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree pulumi.BoolPtrInput `pulumi:"compartmentIdInSubtree"`
	// A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
	DisplayName pulumi.StringPtrInput            `pulumi:"displayName"`
	Filters     GetAlarmStatusesFilterArrayInput `pulumi:"filters"`
}

A collection of arguments for invoking getAlarmStatuses.

func (GetAlarmStatusesOutputArgs) ElementType

func (GetAlarmStatusesOutputArgs) ElementType() reflect.Type

type GetAlarmStatusesResult

type GetAlarmStatusesResult struct {
	// The list of alarm_statuses.
	AlarmStatuses          []GetAlarmStatusesAlarmStatus `pulumi:"alarmStatuses"`
	CompartmentId          string                        `pulumi:"compartmentId"`
	CompartmentIdInSubtree *bool                         `pulumi:"compartmentIdInSubtree"`
	// The configured name of the alarm.  Example: `High CPU Utilization`
	DisplayName *string                  `pulumi:"displayName"`
	Filters     []GetAlarmStatusesFilter `pulumi:"filters"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
}

A collection of values returned by getAlarmStatuses.

func GetAlarmStatuses

func GetAlarmStatuses(ctx *pulumi.Context, args *GetAlarmStatusesArgs, opts ...pulumi.InvokeOption) (*GetAlarmStatusesResult, error)

This data source provides the list of Alarm Statuses in Oracle Cloud Infrastructure Monitoring service.

List the status of each alarm in the specified compartment. For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).

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

```go 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.GetAlarmStatuses(ctx, &monitoring.GetAlarmStatusesArgs{
			CompartmentId:          _var.Compartment_id,
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Alarm_status_compartment_id_in_subtree),
			DisplayName:            pulumi.StringRef(_var.Alarm_status_display_name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetAlarmStatusesResultOutput

type GetAlarmStatusesResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAlarmStatuses.

func (GetAlarmStatusesResultOutput) AlarmStatuses

The list of alarm_statuses.

func (GetAlarmStatusesResultOutput) CompartmentId

func (GetAlarmStatusesResultOutput) CompartmentIdInSubtree

func (o GetAlarmStatusesResultOutput) CompartmentIdInSubtree() pulumi.BoolPtrOutput

func (GetAlarmStatusesResultOutput) DisplayName

The configured name of the alarm. Example: `High CPU Utilization`

func (GetAlarmStatusesResultOutput) ElementType

func (GetAlarmStatusesResultOutput) Filters

func (GetAlarmStatusesResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetAlarmStatusesResultOutput) ToGetAlarmStatusesResultOutput

func (o GetAlarmStatusesResultOutput) ToGetAlarmStatusesResultOutput() GetAlarmStatusesResultOutput

func (GetAlarmStatusesResultOutput) ToGetAlarmStatusesResultOutputWithContext

func (o GetAlarmStatusesResultOutput) ToGetAlarmStatusesResultOutputWithContext(ctx context.Context) GetAlarmStatusesResultOutput

type GetAlarmSuppression

type GetAlarmSuppression struct {
	// Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	Description string `pulumi:"description"`
	// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeSuppressFrom string `pulumi:"timeSuppressFrom"`
	// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T02:02:29.600Z`
	TimeSuppressUntil string `pulumi:"timeSuppressUntil"`
}

type GetAlarmSuppressionArgs

type GetAlarmSuppressionArgs struct {
	// Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	Description pulumi.StringInput `pulumi:"description"`
	// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeSuppressFrom pulumi.StringInput `pulumi:"timeSuppressFrom"`
	// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T02:02:29.600Z`
	TimeSuppressUntil pulumi.StringInput `pulumi:"timeSuppressUntil"`
}

func (GetAlarmSuppressionArgs) ElementType

func (GetAlarmSuppressionArgs) ElementType() reflect.Type

func (GetAlarmSuppressionArgs) ToGetAlarmSuppressionOutput

func (i GetAlarmSuppressionArgs) ToGetAlarmSuppressionOutput() GetAlarmSuppressionOutput

func (GetAlarmSuppressionArgs) ToGetAlarmSuppressionOutputWithContext

func (i GetAlarmSuppressionArgs) ToGetAlarmSuppressionOutputWithContext(ctx context.Context) GetAlarmSuppressionOutput

type GetAlarmSuppressionArray

type GetAlarmSuppressionArray []GetAlarmSuppressionInput

func (GetAlarmSuppressionArray) ElementType

func (GetAlarmSuppressionArray) ElementType() reflect.Type

func (GetAlarmSuppressionArray) ToGetAlarmSuppressionArrayOutput

func (i GetAlarmSuppressionArray) ToGetAlarmSuppressionArrayOutput() GetAlarmSuppressionArrayOutput

func (GetAlarmSuppressionArray) ToGetAlarmSuppressionArrayOutputWithContext

func (i GetAlarmSuppressionArray) ToGetAlarmSuppressionArrayOutputWithContext(ctx context.Context) GetAlarmSuppressionArrayOutput

type GetAlarmSuppressionArrayInput

type GetAlarmSuppressionArrayInput interface {
	pulumi.Input

	ToGetAlarmSuppressionArrayOutput() GetAlarmSuppressionArrayOutput
	ToGetAlarmSuppressionArrayOutputWithContext(context.Context) GetAlarmSuppressionArrayOutput
}

GetAlarmSuppressionArrayInput is an input type that accepts GetAlarmSuppressionArray and GetAlarmSuppressionArrayOutput values. You can construct a concrete instance of `GetAlarmSuppressionArrayInput` via:

GetAlarmSuppressionArray{ GetAlarmSuppressionArgs{...} }

type GetAlarmSuppressionArrayOutput

type GetAlarmSuppressionArrayOutput struct{ *pulumi.OutputState }

func (GetAlarmSuppressionArrayOutput) ElementType

func (GetAlarmSuppressionArrayOutput) Index

func (GetAlarmSuppressionArrayOutput) ToGetAlarmSuppressionArrayOutput

func (o GetAlarmSuppressionArrayOutput) ToGetAlarmSuppressionArrayOutput() GetAlarmSuppressionArrayOutput

func (GetAlarmSuppressionArrayOutput) ToGetAlarmSuppressionArrayOutputWithContext

func (o GetAlarmSuppressionArrayOutput) ToGetAlarmSuppressionArrayOutputWithContext(ctx context.Context) GetAlarmSuppressionArrayOutput

type GetAlarmSuppressionInput

type GetAlarmSuppressionInput interface {
	pulumi.Input

	ToGetAlarmSuppressionOutput() GetAlarmSuppressionOutput
	ToGetAlarmSuppressionOutputWithContext(context.Context) GetAlarmSuppressionOutput
}

GetAlarmSuppressionInput is an input type that accepts GetAlarmSuppressionArgs and GetAlarmSuppressionOutput values. You can construct a concrete instance of `GetAlarmSuppressionInput` via:

GetAlarmSuppressionArgs{...}

type GetAlarmSuppressionOutput

type GetAlarmSuppressionOutput struct{ *pulumi.OutputState }

func (GetAlarmSuppressionOutput) Description

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

func (GetAlarmSuppressionOutput) ElementType

func (GetAlarmSuppressionOutput) ElementType() reflect.Type

func (GetAlarmSuppressionOutput) TimeSuppressFrom

func (o GetAlarmSuppressionOutput) TimeSuppressFrom() pulumi.StringOutput

The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (GetAlarmSuppressionOutput) TimeSuppressUntil

func (o GetAlarmSuppressionOutput) TimeSuppressUntil() pulumi.StringOutput

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

func (GetAlarmSuppressionOutput) ToGetAlarmSuppressionOutput

func (o GetAlarmSuppressionOutput) ToGetAlarmSuppressionOutput() GetAlarmSuppressionOutput

func (GetAlarmSuppressionOutput) ToGetAlarmSuppressionOutputWithContext

func (o GetAlarmSuppressionOutput) ToGetAlarmSuppressionOutputWithContext(ctx context.Context) GetAlarmSuppressionOutput

type GetAlarmsAlarm

type GetAlarmsAlarm struct {
	// The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices.  Example: `High CPU usage alert. Follow runbook instructions for resolution.`
	Body string `pulumi:"body"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId string `pulumi:"compartmentId"`
	// Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
	DefinedTags map[string]interface{} `pulumi:"definedTags"`
	// A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
	Destinations []string `pulumi:"destinations"`
	// A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
	DisplayName string `pulumi:"displayName"`
	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
	FreeformTags map[string]interface{} `pulumi:"freeformTags"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
	Id string `pulumi:"id"`
	// Whether the alarm is enabled.  Example: `true`
	IsEnabled bool `pulumi:"isEnabled"`
	// When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`
	IsNotificationsPerMetricDimensionEnabled bool `pulumi:"isNotificationsPerMetricDimensionEnabled"`
	// The format to use for notification messages sent from this alarm. The formats are:
	MessageFormat string `pulumi:"messageFormat"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
	MetricCompartmentId string `pulumi:"metricCompartmentId"`
	// When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.  Example: `true`
	MetricCompartmentIdInSubtree bool `pulumi:"metricCompartmentIdInSubtree"`
	// The source service or application emitting the metric that is evaluated by the alarm.  Example: `ociComputeagent`
	Namespace string `pulumi:"namespace"`
	// The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
	PendingDuration string `pulumi:"pendingDuration"`
	// The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	Query string `pulumi:"query"`
	// The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.
	RepeatNotificationDuration string `pulumi:"repeatNotificationDuration"`
	// The time between calculated aggregation windows for the alarm. Supported value: `1m`
	Resolution string `pulumi:"resolution"`
	// Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup string `pulumi:"resourceGroup"`
	// The perceived type of response required when the alarm is in the "FIRING" state.  Example: `CRITICAL`
	Severity string `pulumi:"severity"`
	// A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
	State string `pulumi:"state"`
	// The configuration details for suppressing an alarm.
	Suppressions []GetAlarmsAlarmSuppression `pulumi:"suppressions"`
	// The date and time the alarm was created. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeCreated string `pulumi:"timeCreated"`
	// The date and time the alarm was last updated. Format defined by RFC3339.  Example: `2019-02-03T01:02:29.600Z`
	TimeUpdated string `pulumi:"timeUpdated"`
}

type GetAlarmsAlarmArgs

type GetAlarmsAlarmArgs struct {
	// The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices.  Example: `High CPU usage alert. Follow runbook instructions for resolution.`
	Body pulumi.StringInput `pulumi:"body"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId pulumi.StringInput `pulumi:"compartmentId"`
	// Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
	DefinedTags pulumi.MapInput `pulumi:"definedTags"`
	// A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
	Destinations pulumi.StringArrayInput `pulumi:"destinations"`
	// A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
	DisplayName pulumi.StringInput `pulumi:"displayName"`
	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
	FreeformTags pulumi.MapInput `pulumi:"freeformTags"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
	Id pulumi.StringInput `pulumi:"id"`
	// Whether the alarm is enabled.  Example: `true`
	IsEnabled pulumi.BoolInput `pulumi:"isEnabled"`
	// When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`
	IsNotificationsPerMetricDimensionEnabled pulumi.BoolInput `pulumi:"isNotificationsPerMetricDimensionEnabled"`
	// The format to use for notification messages sent from this alarm. The formats are:
	MessageFormat pulumi.StringInput `pulumi:"messageFormat"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
	MetricCompartmentId pulumi.StringInput `pulumi:"metricCompartmentId"`
	// When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.  Example: `true`
	MetricCompartmentIdInSubtree pulumi.BoolInput `pulumi:"metricCompartmentIdInSubtree"`
	// The source service or application emitting the metric that is evaluated by the alarm.  Example: `ociComputeagent`
	Namespace pulumi.StringInput `pulumi:"namespace"`
	// The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
	PendingDuration pulumi.StringInput `pulumi:"pendingDuration"`
	// The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	Query pulumi.StringInput `pulumi:"query"`
	// The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.
	RepeatNotificationDuration pulumi.StringInput `pulumi:"repeatNotificationDuration"`
	// The time between calculated aggregation windows for the alarm. Supported value: `1m`
	Resolution pulumi.StringInput `pulumi:"resolution"`
	// Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup pulumi.StringInput `pulumi:"resourceGroup"`
	// The perceived type of response required when the alarm is in the "FIRING" state.  Example: `CRITICAL`
	Severity pulumi.StringInput `pulumi:"severity"`
	// A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
	State pulumi.StringInput `pulumi:"state"`
	// The configuration details for suppressing an alarm.
	Suppressions GetAlarmsAlarmSuppressionArrayInput `pulumi:"suppressions"`
	// The date and time the alarm was created. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeCreated pulumi.StringInput `pulumi:"timeCreated"`
	// The date and time the alarm was last updated. Format defined by RFC3339.  Example: `2019-02-03T01:02:29.600Z`
	TimeUpdated pulumi.StringInput `pulumi:"timeUpdated"`
}

func (GetAlarmsAlarmArgs) ElementType

func (GetAlarmsAlarmArgs) ElementType() reflect.Type

func (GetAlarmsAlarmArgs) ToGetAlarmsAlarmOutput

func (i GetAlarmsAlarmArgs) ToGetAlarmsAlarmOutput() GetAlarmsAlarmOutput

func (GetAlarmsAlarmArgs) ToGetAlarmsAlarmOutputWithContext

func (i GetAlarmsAlarmArgs) ToGetAlarmsAlarmOutputWithContext(ctx context.Context) GetAlarmsAlarmOutput

type GetAlarmsAlarmArray

type GetAlarmsAlarmArray []GetAlarmsAlarmInput

func (GetAlarmsAlarmArray) ElementType

func (GetAlarmsAlarmArray) ElementType() reflect.Type

func (GetAlarmsAlarmArray) ToGetAlarmsAlarmArrayOutput

func (i GetAlarmsAlarmArray) ToGetAlarmsAlarmArrayOutput() GetAlarmsAlarmArrayOutput

func (GetAlarmsAlarmArray) ToGetAlarmsAlarmArrayOutputWithContext

func (i GetAlarmsAlarmArray) ToGetAlarmsAlarmArrayOutputWithContext(ctx context.Context) GetAlarmsAlarmArrayOutput

type GetAlarmsAlarmArrayInput

type GetAlarmsAlarmArrayInput interface {
	pulumi.Input

	ToGetAlarmsAlarmArrayOutput() GetAlarmsAlarmArrayOutput
	ToGetAlarmsAlarmArrayOutputWithContext(context.Context) GetAlarmsAlarmArrayOutput
}

GetAlarmsAlarmArrayInput is an input type that accepts GetAlarmsAlarmArray and GetAlarmsAlarmArrayOutput values. You can construct a concrete instance of `GetAlarmsAlarmArrayInput` via:

GetAlarmsAlarmArray{ GetAlarmsAlarmArgs{...} }

type GetAlarmsAlarmArrayOutput

type GetAlarmsAlarmArrayOutput struct{ *pulumi.OutputState }

func (GetAlarmsAlarmArrayOutput) ElementType

func (GetAlarmsAlarmArrayOutput) ElementType() reflect.Type

func (GetAlarmsAlarmArrayOutput) Index

func (GetAlarmsAlarmArrayOutput) ToGetAlarmsAlarmArrayOutput

func (o GetAlarmsAlarmArrayOutput) ToGetAlarmsAlarmArrayOutput() GetAlarmsAlarmArrayOutput

func (GetAlarmsAlarmArrayOutput) ToGetAlarmsAlarmArrayOutputWithContext

func (o GetAlarmsAlarmArrayOutput) ToGetAlarmsAlarmArrayOutputWithContext(ctx context.Context) GetAlarmsAlarmArrayOutput

type GetAlarmsAlarmInput

type GetAlarmsAlarmInput interface {
	pulumi.Input

	ToGetAlarmsAlarmOutput() GetAlarmsAlarmOutput
	ToGetAlarmsAlarmOutputWithContext(context.Context) GetAlarmsAlarmOutput
}

GetAlarmsAlarmInput is an input type that accepts GetAlarmsAlarmArgs and GetAlarmsAlarmOutput values. You can construct a concrete instance of `GetAlarmsAlarmInput` via:

GetAlarmsAlarmArgs{...}

type GetAlarmsAlarmOutput

type GetAlarmsAlarmOutput struct{ *pulumi.OutputState }

func (GetAlarmsAlarmOutput) Body

The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example: `High CPU usage alert. Follow runbook instructions for resolution.`

func (GetAlarmsAlarmOutput) CompartmentId

func (o GetAlarmsAlarmOutput) CompartmentId() pulumi.StringOutput

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: `ocid1.compartment.oc1..exampleuniqueID`

func (GetAlarmsAlarmOutput) DefinedTags

func (o GetAlarmsAlarmOutput) DefinedTags() pulumi.MapOutput

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`

func (GetAlarmsAlarmOutput) Destinations

A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.

func (GetAlarmsAlarmOutput) DisplayName

func (o GetAlarmsAlarmOutput) DisplayName() pulumi.StringOutput

A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

func (GetAlarmsAlarmOutput) ElementType

func (GetAlarmsAlarmOutput) ElementType() reflect.Type

func (GetAlarmsAlarmOutput) FreeformTags

func (o GetAlarmsAlarmOutput) FreeformTags() pulumi.MapOutput

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

func (GetAlarmsAlarmOutput) IsEnabled

func (o GetAlarmsAlarmOutput) IsEnabled() pulumi.BoolOutput

Whether the alarm is enabled. Example: `true`

func (GetAlarmsAlarmOutput) IsNotificationsPerMetricDimensionEnabled added in v0.5.0

func (o GetAlarmsAlarmOutput) IsNotificationsPerMetricDimensionEnabled() pulumi.BoolOutput

When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`

func (GetAlarmsAlarmOutput) MessageFormat

func (o GetAlarmsAlarmOutput) MessageFormat() pulumi.StringOutput

The format to use for notification messages sent from this alarm. The formats are:

func (GetAlarmsAlarmOutput) MetricCompartmentId

func (o GetAlarmsAlarmOutput) MetricCompartmentId() pulumi.StringOutput

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.

func (GetAlarmsAlarmOutput) MetricCompartmentIdInSubtree

func (o GetAlarmsAlarmOutput) MetricCompartmentIdInSubtree() pulumi.BoolOutput

When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: `true`

func (GetAlarmsAlarmOutput) Namespace

The source service or application emitting the metric that is evaluated by the alarm. Example: `ociComputeagent`

func (GetAlarmsAlarmOutput) PendingDuration

func (o GetAlarmsAlarmOutput) PendingDuration() pulumi.StringOutput

The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".

func (GetAlarmsAlarmOutput) Query

The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).

func (GetAlarmsAlarmOutput) RepeatNotificationDuration

func (o GetAlarmsAlarmOutput) RepeatNotificationDuration() pulumi.StringOutput

The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.

func (GetAlarmsAlarmOutput) Resolution

func (o GetAlarmsAlarmOutput) Resolution() pulumi.StringOutput

The time between calculated aggregation windows for the alarm. Supported value: `1m`

func (GetAlarmsAlarmOutput) ResourceGroup

func (o GetAlarmsAlarmOutput) ResourceGroup() pulumi.StringOutput

Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`

func (GetAlarmsAlarmOutput) Severity

The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`

func (GetAlarmsAlarmOutput) State

A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.

func (GetAlarmsAlarmOutput) Suppressions

The configuration details for suppressing an alarm.

func (GetAlarmsAlarmOutput) TimeCreated

func (o GetAlarmsAlarmOutput) TimeCreated() pulumi.StringOutput

The date and time the alarm was created. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (GetAlarmsAlarmOutput) TimeUpdated

func (o GetAlarmsAlarmOutput) TimeUpdated() pulumi.StringOutput

The date and time the alarm was last updated. Format defined by RFC3339. Example: `2019-02-03T01:02:29.600Z`

func (GetAlarmsAlarmOutput) ToGetAlarmsAlarmOutput

func (o GetAlarmsAlarmOutput) ToGetAlarmsAlarmOutput() GetAlarmsAlarmOutput

func (GetAlarmsAlarmOutput) ToGetAlarmsAlarmOutputWithContext

func (o GetAlarmsAlarmOutput) ToGetAlarmsAlarmOutputWithContext(ctx context.Context) GetAlarmsAlarmOutput

type GetAlarmsAlarmSuppression

type GetAlarmsAlarmSuppression struct {
	// Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	Description string `pulumi:"description"`
	// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeSuppressFrom string `pulumi:"timeSuppressFrom"`
	// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T02:02:29.600Z`
	TimeSuppressUntil string `pulumi:"timeSuppressUntil"`
}

type GetAlarmsAlarmSuppressionArgs

type GetAlarmsAlarmSuppressionArgs struct {
	// Human-readable reason for suppressing alarm notifications. It does not have to be unique, and it's changeable. Avoid entering confidential information.
	Description pulumi.StringInput `pulumi:"description"`
	// The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeSuppressFrom pulumi.StringInput `pulumi:"timeSuppressFrom"`
	// The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.  Example: `2019-02-01T02:02:29.600Z`
	TimeSuppressUntil pulumi.StringInput `pulumi:"timeSuppressUntil"`
}

func (GetAlarmsAlarmSuppressionArgs) ElementType

func (GetAlarmsAlarmSuppressionArgs) ToGetAlarmsAlarmSuppressionOutput

func (i GetAlarmsAlarmSuppressionArgs) ToGetAlarmsAlarmSuppressionOutput() GetAlarmsAlarmSuppressionOutput

func (GetAlarmsAlarmSuppressionArgs) ToGetAlarmsAlarmSuppressionOutputWithContext

func (i GetAlarmsAlarmSuppressionArgs) ToGetAlarmsAlarmSuppressionOutputWithContext(ctx context.Context) GetAlarmsAlarmSuppressionOutput

type GetAlarmsAlarmSuppressionArray

type GetAlarmsAlarmSuppressionArray []GetAlarmsAlarmSuppressionInput

func (GetAlarmsAlarmSuppressionArray) ElementType

func (GetAlarmsAlarmSuppressionArray) ToGetAlarmsAlarmSuppressionArrayOutput

func (i GetAlarmsAlarmSuppressionArray) ToGetAlarmsAlarmSuppressionArrayOutput() GetAlarmsAlarmSuppressionArrayOutput

func (GetAlarmsAlarmSuppressionArray) ToGetAlarmsAlarmSuppressionArrayOutputWithContext

func (i GetAlarmsAlarmSuppressionArray) ToGetAlarmsAlarmSuppressionArrayOutputWithContext(ctx context.Context) GetAlarmsAlarmSuppressionArrayOutput

type GetAlarmsAlarmSuppressionArrayInput

type GetAlarmsAlarmSuppressionArrayInput interface {
	pulumi.Input

	ToGetAlarmsAlarmSuppressionArrayOutput() GetAlarmsAlarmSuppressionArrayOutput
	ToGetAlarmsAlarmSuppressionArrayOutputWithContext(context.Context) GetAlarmsAlarmSuppressionArrayOutput
}

GetAlarmsAlarmSuppressionArrayInput is an input type that accepts GetAlarmsAlarmSuppressionArray and GetAlarmsAlarmSuppressionArrayOutput values. You can construct a concrete instance of `GetAlarmsAlarmSuppressionArrayInput` via:

GetAlarmsAlarmSuppressionArray{ GetAlarmsAlarmSuppressionArgs{...} }

type GetAlarmsAlarmSuppressionArrayOutput

type GetAlarmsAlarmSuppressionArrayOutput struct{ *pulumi.OutputState }

func (GetAlarmsAlarmSuppressionArrayOutput) ElementType

func (GetAlarmsAlarmSuppressionArrayOutput) Index

func (GetAlarmsAlarmSuppressionArrayOutput) ToGetAlarmsAlarmSuppressionArrayOutput

func (o GetAlarmsAlarmSuppressionArrayOutput) ToGetAlarmsAlarmSuppressionArrayOutput() GetAlarmsAlarmSuppressionArrayOutput

func (GetAlarmsAlarmSuppressionArrayOutput) ToGetAlarmsAlarmSuppressionArrayOutputWithContext

func (o GetAlarmsAlarmSuppressionArrayOutput) ToGetAlarmsAlarmSuppressionArrayOutputWithContext(ctx context.Context) GetAlarmsAlarmSuppressionArrayOutput

type GetAlarmsAlarmSuppressionInput

type GetAlarmsAlarmSuppressionInput interface {
	pulumi.Input

	ToGetAlarmsAlarmSuppressionOutput() GetAlarmsAlarmSuppressionOutput
	ToGetAlarmsAlarmSuppressionOutputWithContext(context.Context) GetAlarmsAlarmSuppressionOutput
}

GetAlarmsAlarmSuppressionInput is an input type that accepts GetAlarmsAlarmSuppressionArgs and GetAlarmsAlarmSuppressionOutput values. You can construct a concrete instance of `GetAlarmsAlarmSuppressionInput` via:

GetAlarmsAlarmSuppressionArgs{...}

type GetAlarmsAlarmSuppressionOutput

type GetAlarmsAlarmSuppressionOutput struct{ *pulumi.OutputState }

func (GetAlarmsAlarmSuppressionOutput) Description

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

func (GetAlarmsAlarmSuppressionOutput) ElementType

func (GetAlarmsAlarmSuppressionOutput) TimeSuppressFrom

The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (GetAlarmsAlarmSuppressionOutput) TimeSuppressUntil

func (o GetAlarmsAlarmSuppressionOutput) TimeSuppressUntil() pulumi.StringOutput

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

func (GetAlarmsAlarmSuppressionOutput) ToGetAlarmsAlarmSuppressionOutput

func (o GetAlarmsAlarmSuppressionOutput) ToGetAlarmsAlarmSuppressionOutput() GetAlarmsAlarmSuppressionOutput

func (GetAlarmsAlarmSuppressionOutput) ToGetAlarmsAlarmSuppressionOutputWithContext

func (o GetAlarmsAlarmSuppressionOutput) ToGetAlarmsAlarmSuppressionOutputWithContext(ctx context.Context) GetAlarmsAlarmSuppressionOutput

type GetAlarmsArgs

type GetAlarmsArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId string `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree *bool `pulumi:"compartmentIdInSubtree"`
	// A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
	DisplayName *string           `pulumi:"displayName"`
	Filters     []GetAlarmsFilter `pulumi:"filters"`
	// A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
	State *string `pulumi:"state"`
}

A collection of arguments for invoking getAlarms.

type GetAlarmsFilter

type GetAlarmsFilter struct {
	Name   string   `pulumi:"name"`
	Regex  *bool    `pulumi:"regex"`
	Values []string `pulumi:"values"`
}

type GetAlarmsFilterArgs

type GetAlarmsFilterArgs struct {
	Name   pulumi.StringInput      `pulumi:"name"`
	Regex  pulumi.BoolPtrInput     `pulumi:"regex"`
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GetAlarmsFilterArgs) ElementType

func (GetAlarmsFilterArgs) ElementType() reflect.Type

func (GetAlarmsFilterArgs) ToGetAlarmsFilterOutput

func (i GetAlarmsFilterArgs) ToGetAlarmsFilterOutput() GetAlarmsFilterOutput

func (GetAlarmsFilterArgs) ToGetAlarmsFilterOutputWithContext

func (i GetAlarmsFilterArgs) ToGetAlarmsFilterOutputWithContext(ctx context.Context) GetAlarmsFilterOutput

type GetAlarmsFilterArray

type GetAlarmsFilterArray []GetAlarmsFilterInput

func (GetAlarmsFilterArray) ElementType

func (GetAlarmsFilterArray) ElementType() reflect.Type

func (GetAlarmsFilterArray) ToGetAlarmsFilterArrayOutput

func (i GetAlarmsFilterArray) ToGetAlarmsFilterArrayOutput() GetAlarmsFilterArrayOutput

func (GetAlarmsFilterArray) ToGetAlarmsFilterArrayOutputWithContext

func (i GetAlarmsFilterArray) ToGetAlarmsFilterArrayOutputWithContext(ctx context.Context) GetAlarmsFilterArrayOutput

type GetAlarmsFilterArrayInput

type GetAlarmsFilterArrayInput interface {
	pulumi.Input

	ToGetAlarmsFilterArrayOutput() GetAlarmsFilterArrayOutput
	ToGetAlarmsFilterArrayOutputWithContext(context.Context) GetAlarmsFilterArrayOutput
}

GetAlarmsFilterArrayInput is an input type that accepts GetAlarmsFilterArray and GetAlarmsFilterArrayOutput values. You can construct a concrete instance of `GetAlarmsFilterArrayInput` via:

GetAlarmsFilterArray{ GetAlarmsFilterArgs{...} }

type GetAlarmsFilterArrayOutput

type GetAlarmsFilterArrayOutput struct{ *pulumi.OutputState }

func (GetAlarmsFilterArrayOutput) ElementType

func (GetAlarmsFilterArrayOutput) ElementType() reflect.Type

func (GetAlarmsFilterArrayOutput) Index

func (GetAlarmsFilterArrayOutput) ToGetAlarmsFilterArrayOutput

func (o GetAlarmsFilterArrayOutput) ToGetAlarmsFilterArrayOutput() GetAlarmsFilterArrayOutput

func (GetAlarmsFilterArrayOutput) ToGetAlarmsFilterArrayOutputWithContext

func (o GetAlarmsFilterArrayOutput) ToGetAlarmsFilterArrayOutputWithContext(ctx context.Context) GetAlarmsFilterArrayOutput

type GetAlarmsFilterInput

type GetAlarmsFilterInput interface {
	pulumi.Input

	ToGetAlarmsFilterOutput() GetAlarmsFilterOutput
	ToGetAlarmsFilterOutputWithContext(context.Context) GetAlarmsFilterOutput
}

GetAlarmsFilterInput is an input type that accepts GetAlarmsFilterArgs and GetAlarmsFilterOutput values. You can construct a concrete instance of `GetAlarmsFilterInput` via:

GetAlarmsFilterArgs{...}

type GetAlarmsFilterOutput

type GetAlarmsFilterOutput struct{ *pulumi.OutputState }

func (GetAlarmsFilterOutput) ElementType

func (GetAlarmsFilterOutput) ElementType() reflect.Type

func (GetAlarmsFilterOutput) Name

func (GetAlarmsFilterOutput) Regex

func (GetAlarmsFilterOutput) ToGetAlarmsFilterOutput

func (o GetAlarmsFilterOutput) ToGetAlarmsFilterOutput() GetAlarmsFilterOutput

func (GetAlarmsFilterOutput) ToGetAlarmsFilterOutputWithContext

func (o GetAlarmsFilterOutput) ToGetAlarmsFilterOutputWithContext(ctx context.Context) GetAlarmsFilterOutput

func (GetAlarmsFilterOutput) Values

type GetAlarmsOutputArgs

type GetAlarmsOutputArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId pulumi.StringInput `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree pulumi.BoolPtrInput `pulumi:"compartmentIdInSubtree"`
	// A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
	DisplayName pulumi.StringPtrInput     `pulumi:"displayName"`
	Filters     GetAlarmsFilterArrayInput `pulumi:"filters"`
	// A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
	State pulumi.StringPtrInput `pulumi:"state"`
}

A collection of arguments for invoking getAlarms.

func (GetAlarmsOutputArgs) ElementType

func (GetAlarmsOutputArgs) ElementType() reflect.Type

type GetAlarmsResult

type GetAlarmsResult struct {
	// The list of alarms.
	Alarms []GetAlarmsAlarm `pulumi:"alarms"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
	CompartmentId          string `pulumi:"compartmentId"`
	CompartmentIdInSubtree *bool  `pulumi:"compartmentIdInSubtree"`
	// A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
	DisplayName *string           `pulumi:"displayName"`
	Filters     []GetAlarmsFilter `pulumi:"filters"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The current lifecycle state of the alarm.  Example: `DELETED`
	State *string `pulumi:"state"`
}

A collection of values returned by getAlarms.

func GetAlarms

func GetAlarms(ctx *pulumi.Context, args *GetAlarmsArgs, opts ...pulumi.InvokeOption) (*GetAlarmsResult, error)

This data source provides the list of Alarms in Oracle Cloud Infrastructure Monitoring service.

Lists the alarms for the specified compartment. For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).

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

```go 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.GetAlarms(ctx, &monitoring.GetAlarmsArgs{
			CompartmentId:          _var.Compartment_id,
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Alarm_compartment_id_in_subtree),
			DisplayName:            pulumi.StringRef(_var.Alarm_display_name),
			State:                  pulumi.StringRef(_var.Alarm_state),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetAlarmsResultOutput

type GetAlarmsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAlarms.

func (GetAlarmsResultOutput) Alarms

The list of alarms.

func (GetAlarmsResultOutput) CompartmentId

func (o GetAlarmsResultOutput) CompartmentId() pulumi.StringOutput

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.

func (GetAlarmsResultOutput) CompartmentIdInSubtree

func (o GetAlarmsResultOutput) CompartmentIdInSubtree() pulumi.BoolPtrOutput

func (GetAlarmsResultOutput) DisplayName

A user-friendly name for the alarm. It does not have to be unique, and it's changeable.

func (GetAlarmsResultOutput) ElementType

func (GetAlarmsResultOutput) ElementType() reflect.Type

func (GetAlarmsResultOutput) Filters

func (GetAlarmsResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetAlarmsResultOutput) State

The current lifecycle state of the alarm. Example: `DELETED`

func (GetAlarmsResultOutput) ToGetAlarmsResultOutput

func (o GetAlarmsResultOutput) ToGetAlarmsResultOutput() GetAlarmsResultOutput

func (GetAlarmsResultOutput) ToGetAlarmsResultOutputWithContext

func (o GetAlarmsResultOutput) ToGetAlarmsResultOutputWithContext(ctx context.Context) GetAlarmsResultOutput

type GetMetricDataArgs

type GetMetricDataArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId string `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree *bool `pulumi:"compartmentIdInSubtree"`
	// The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent.  Example: `2019-02-01T02:02:29.600Z`
	EndTime *string               `pulumi:"endTime"`
	Filters []GetMetricDataFilter `pulumi:"filters"`
	// The source service or application to use when searching for metric data points to aggregate.  Example: `ociComputeagent`
	Namespace string `pulumi:"namespace"`
	// The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.
	//
	// Construct your query to avoid exceeding limits on returned data. See [MetricData Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/20180401/MetricData).
	//
	// For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	//
	// Example: `CpuUtilization[1m].sum()`
	Query string `pulumi:"query"`
	// The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.  Example: `5m`
	Resolution *string `pulumi:"resolution"`
	// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup *string `pulumi:"resourceGroup"`
	// The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent.  Example: `2019-02-01T01:02:29.600Z`
	StartTime *string `pulumi:"startTime"`
}

A collection of arguments for invoking getMetricData.

type GetMetricDataFilter

type GetMetricDataFilter struct {
	// The name of the metric.  Example: `CpuUtilization`
	Name   string   `pulumi:"name"`
	Regex  *bool    `pulumi:"regex"`
	Values []string `pulumi:"values"`
}

type GetMetricDataFilterArgs

type GetMetricDataFilterArgs struct {
	// The name of the metric.  Example: `CpuUtilization`
	Name   pulumi.StringInput      `pulumi:"name"`
	Regex  pulumi.BoolPtrInput     `pulumi:"regex"`
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GetMetricDataFilterArgs) ElementType

func (GetMetricDataFilterArgs) ElementType() reflect.Type

func (GetMetricDataFilterArgs) ToGetMetricDataFilterOutput

func (i GetMetricDataFilterArgs) ToGetMetricDataFilterOutput() GetMetricDataFilterOutput

func (GetMetricDataFilterArgs) ToGetMetricDataFilterOutputWithContext

func (i GetMetricDataFilterArgs) ToGetMetricDataFilterOutputWithContext(ctx context.Context) GetMetricDataFilterOutput

type GetMetricDataFilterArray

type GetMetricDataFilterArray []GetMetricDataFilterInput

func (GetMetricDataFilterArray) ElementType

func (GetMetricDataFilterArray) ElementType() reflect.Type

func (GetMetricDataFilterArray) ToGetMetricDataFilterArrayOutput

func (i GetMetricDataFilterArray) ToGetMetricDataFilterArrayOutput() GetMetricDataFilterArrayOutput

func (GetMetricDataFilterArray) ToGetMetricDataFilterArrayOutputWithContext

func (i GetMetricDataFilterArray) ToGetMetricDataFilterArrayOutputWithContext(ctx context.Context) GetMetricDataFilterArrayOutput

type GetMetricDataFilterArrayInput

type GetMetricDataFilterArrayInput interface {
	pulumi.Input

	ToGetMetricDataFilterArrayOutput() GetMetricDataFilterArrayOutput
	ToGetMetricDataFilterArrayOutputWithContext(context.Context) GetMetricDataFilterArrayOutput
}

GetMetricDataFilterArrayInput is an input type that accepts GetMetricDataFilterArray and GetMetricDataFilterArrayOutput values. You can construct a concrete instance of `GetMetricDataFilterArrayInput` via:

GetMetricDataFilterArray{ GetMetricDataFilterArgs{...} }

type GetMetricDataFilterArrayOutput

type GetMetricDataFilterArrayOutput struct{ *pulumi.OutputState }

func (GetMetricDataFilterArrayOutput) ElementType

func (GetMetricDataFilterArrayOutput) Index

func (GetMetricDataFilterArrayOutput) ToGetMetricDataFilterArrayOutput

func (o GetMetricDataFilterArrayOutput) ToGetMetricDataFilterArrayOutput() GetMetricDataFilterArrayOutput

func (GetMetricDataFilterArrayOutput) ToGetMetricDataFilterArrayOutputWithContext

func (o GetMetricDataFilterArrayOutput) ToGetMetricDataFilterArrayOutputWithContext(ctx context.Context) GetMetricDataFilterArrayOutput

type GetMetricDataFilterInput

type GetMetricDataFilterInput interface {
	pulumi.Input

	ToGetMetricDataFilterOutput() GetMetricDataFilterOutput
	ToGetMetricDataFilterOutputWithContext(context.Context) GetMetricDataFilterOutput
}

GetMetricDataFilterInput is an input type that accepts GetMetricDataFilterArgs and GetMetricDataFilterOutput values. You can construct a concrete instance of `GetMetricDataFilterInput` via:

GetMetricDataFilterArgs{...}

type GetMetricDataFilterOutput

type GetMetricDataFilterOutput struct{ *pulumi.OutputState }

func (GetMetricDataFilterOutput) ElementType

func (GetMetricDataFilterOutput) ElementType() reflect.Type

func (GetMetricDataFilterOutput) Name

The name of the metric. Example: `CpuUtilization`

func (GetMetricDataFilterOutput) Regex

func (GetMetricDataFilterOutput) ToGetMetricDataFilterOutput

func (o GetMetricDataFilterOutput) ToGetMetricDataFilterOutput() GetMetricDataFilterOutput

func (GetMetricDataFilterOutput) ToGetMetricDataFilterOutputWithContext

func (o GetMetricDataFilterOutput) ToGetMetricDataFilterOutputWithContext(ctx context.Context) GetMetricDataFilterOutput

func (GetMetricDataFilterOutput) Values

type GetMetricDataMetricData

type GetMetricDataMetricData struct {
	// The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.
	AggregatedDatapoints []GetMetricDataMetricDataAggregatedDatapoint `pulumi:"aggregatedDatapoints"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId string `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree bool `pulumi:"compartmentIdInSubtree"`
	// Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.  Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
	Dimensions map[string]interface{} `pulumi:"dimensions"`
	// The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent.  Example: `2019-02-01T02:02:29.600Z`
	EndTime string `pulumi:"endTime"`
	// The references provided in a metric definition to indicate extra information about the metric.  Example: `"unit": "bytes"`
	Metadata map[string]interface{} `pulumi:"metadata"`
	// The name of the metric.  Example: `CpuUtilization`
	Name string `pulumi:"name"`
	// The source service or application to use when searching for metric data points to aggregate.  Example: `ociComputeagent`
	Namespace string `pulumi:"namespace"`
	// The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.
	//
	// Construct your query to avoid exceeding limits on returned data. See [MetricData Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/20180401/MetricData).
	//
	// For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	//
	// Example: `CpuUtilization[1m].sum()`
	Query string `pulumi:"query"`
	// The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.  Example: `5m`
	Resolution string `pulumi:"resolution"`
	// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup string `pulumi:"resourceGroup"`
	// The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent.  Example: `2019-02-01T01:02:29.600Z`
	StartTime string `pulumi:"startTime"`
}

type GetMetricDataMetricDataAggregatedDatapoint

type GetMetricDataMetricDataAggregatedDatapoint struct {
	// The date and time associated with the value of this data point. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	Timestamp string `pulumi:"timestamp"`
	// Numeric value of the metric.  Example: `10.4`
	Value float64 `pulumi:"value"`
}

type GetMetricDataMetricDataAggregatedDatapointArgs

type GetMetricDataMetricDataAggregatedDatapointArgs struct {
	// The date and time associated with the value of this data point. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	Timestamp pulumi.StringInput `pulumi:"timestamp"`
	// Numeric value of the metric.  Example: `10.4`
	Value pulumi.Float64Input `pulumi:"value"`
}

func (GetMetricDataMetricDataAggregatedDatapointArgs) ElementType

func (GetMetricDataMetricDataAggregatedDatapointArgs) ToGetMetricDataMetricDataAggregatedDatapointOutput

func (i GetMetricDataMetricDataAggregatedDatapointArgs) ToGetMetricDataMetricDataAggregatedDatapointOutput() GetMetricDataMetricDataAggregatedDatapointOutput

func (GetMetricDataMetricDataAggregatedDatapointArgs) ToGetMetricDataMetricDataAggregatedDatapointOutputWithContext

func (i GetMetricDataMetricDataAggregatedDatapointArgs) ToGetMetricDataMetricDataAggregatedDatapointOutputWithContext(ctx context.Context) GetMetricDataMetricDataAggregatedDatapointOutput

type GetMetricDataMetricDataAggregatedDatapointArray

type GetMetricDataMetricDataAggregatedDatapointArray []GetMetricDataMetricDataAggregatedDatapointInput

func (GetMetricDataMetricDataAggregatedDatapointArray) ElementType

func (GetMetricDataMetricDataAggregatedDatapointArray) ToGetMetricDataMetricDataAggregatedDatapointArrayOutput

func (i GetMetricDataMetricDataAggregatedDatapointArray) ToGetMetricDataMetricDataAggregatedDatapointArrayOutput() GetMetricDataMetricDataAggregatedDatapointArrayOutput

func (GetMetricDataMetricDataAggregatedDatapointArray) ToGetMetricDataMetricDataAggregatedDatapointArrayOutputWithContext

func (i GetMetricDataMetricDataAggregatedDatapointArray) ToGetMetricDataMetricDataAggregatedDatapointArrayOutputWithContext(ctx context.Context) GetMetricDataMetricDataAggregatedDatapointArrayOutput

type GetMetricDataMetricDataAggregatedDatapointArrayInput

type GetMetricDataMetricDataAggregatedDatapointArrayInput interface {
	pulumi.Input

	ToGetMetricDataMetricDataAggregatedDatapointArrayOutput() GetMetricDataMetricDataAggregatedDatapointArrayOutput
	ToGetMetricDataMetricDataAggregatedDatapointArrayOutputWithContext(context.Context) GetMetricDataMetricDataAggregatedDatapointArrayOutput
}

GetMetricDataMetricDataAggregatedDatapointArrayInput is an input type that accepts GetMetricDataMetricDataAggregatedDatapointArray and GetMetricDataMetricDataAggregatedDatapointArrayOutput values. You can construct a concrete instance of `GetMetricDataMetricDataAggregatedDatapointArrayInput` via:

GetMetricDataMetricDataAggregatedDatapointArray{ GetMetricDataMetricDataAggregatedDatapointArgs{...} }

type GetMetricDataMetricDataAggregatedDatapointArrayOutput

type GetMetricDataMetricDataAggregatedDatapointArrayOutput struct{ *pulumi.OutputState }

func (GetMetricDataMetricDataAggregatedDatapointArrayOutput) ElementType

func (GetMetricDataMetricDataAggregatedDatapointArrayOutput) Index

func (GetMetricDataMetricDataAggregatedDatapointArrayOutput) ToGetMetricDataMetricDataAggregatedDatapointArrayOutput

func (GetMetricDataMetricDataAggregatedDatapointArrayOutput) ToGetMetricDataMetricDataAggregatedDatapointArrayOutputWithContext

func (o GetMetricDataMetricDataAggregatedDatapointArrayOutput) ToGetMetricDataMetricDataAggregatedDatapointArrayOutputWithContext(ctx context.Context) GetMetricDataMetricDataAggregatedDatapointArrayOutput

type GetMetricDataMetricDataAggregatedDatapointInput

type GetMetricDataMetricDataAggregatedDatapointInput interface {
	pulumi.Input

	ToGetMetricDataMetricDataAggregatedDatapointOutput() GetMetricDataMetricDataAggregatedDatapointOutput
	ToGetMetricDataMetricDataAggregatedDatapointOutputWithContext(context.Context) GetMetricDataMetricDataAggregatedDatapointOutput
}

GetMetricDataMetricDataAggregatedDatapointInput is an input type that accepts GetMetricDataMetricDataAggregatedDatapointArgs and GetMetricDataMetricDataAggregatedDatapointOutput values. You can construct a concrete instance of `GetMetricDataMetricDataAggregatedDatapointInput` via:

GetMetricDataMetricDataAggregatedDatapointArgs{...}

type GetMetricDataMetricDataAggregatedDatapointOutput

type GetMetricDataMetricDataAggregatedDatapointOutput struct{ *pulumi.OutputState }

func (GetMetricDataMetricDataAggregatedDatapointOutput) ElementType

func (GetMetricDataMetricDataAggregatedDatapointOutput) Timestamp

The date and time associated with the value of this data point. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (GetMetricDataMetricDataAggregatedDatapointOutput) ToGetMetricDataMetricDataAggregatedDatapointOutput

func (o GetMetricDataMetricDataAggregatedDatapointOutput) ToGetMetricDataMetricDataAggregatedDatapointOutput() GetMetricDataMetricDataAggregatedDatapointOutput

func (GetMetricDataMetricDataAggregatedDatapointOutput) ToGetMetricDataMetricDataAggregatedDatapointOutputWithContext

func (o GetMetricDataMetricDataAggregatedDatapointOutput) ToGetMetricDataMetricDataAggregatedDatapointOutputWithContext(ctx context.Context) GetMetricDataMetricDataAggregatedDatapointOutput

func (GetMetricDataMetricDataAggregatedDatapointOutput) Value

Numeric value of the metric. Example: `10.4`

type GetMetricDataMetricDataArgs

type GetMetricDataMetricDataArgs struct {
	// The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.
	AggregatedDatapoints GetMetricDataMetricDataAggregatedDatapointArrayInput `pulumi:"aggregatedDatapoints"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId pulumi.StringInput `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree pulumi.BoolInput `pulumi:"compartmentIdInSubtree"`
	// Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.  Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
	Dimensions pulumi.MapInput `pulumi:"dimensions"`
	// The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent.  Example: `2019-02-01T02:02:29.600Z`
	EndTime pulumi.StringInput `pulumi:"endTime"`
	// The references provided in a metric definition to indicate extra information about the metric.  Example: `"unit": "bytes"`
	Metadata pulumi.MapInput `pulumi:"metadata"`
	// The name of the metric.  Example: `CpuUtilization`
	Name pulumi.StringInput `pulumi:"name"`
	// The source service or application to use when searching for metric data points to aggregate.  Example: `ociComputeagent`
	Namespace pulumi.StringInput `pulumi:"namespace"`
	// The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.
	//
	// Construct your query to avoid exceeding limits on returned data. See [MetricData Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/20180401/MetricData).
	//
	// For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	//
	// Example: `CpuUtilization[1m].sum()`
	Query pulumi.StringInput `pulumi:"query"`
	// The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.  Example: `5m`
	Resolution pulumi.StringInput `pulumi:"resolution"`
	// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup pulumi.StringInput `pulumi:"resourceGroup"`
	// The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent.  Example: `2019-02-01T01:02:29.600Z`
	StartTime pulumi.StringInput `pulumi:"startTime"`
}

func (GetMetricDataMetricDataArgs) ElementType

func (GetMetricDataMetricDataArgs) ToGetMetricDataMetricDataOutput

func (i GetMetricDataMetricDataArgs) ToGetMetricDataMetricDataOutput() GetMetricDataMetricDataOutput

func (GetMetricDataMetricDataArgs) ToGetMetricDataMetricDataOutputWithContext

func (i GetMetricDataMetricDataArgs) ToGetMetricDataMetricDataOutputWithContext(ctx context.Context) GetMetricDataMetricDataOutput

type GetMetricDataMetricDataArray

type GetMetricDataMetricDataArray []GetMetricDataMetricDataInput

func (GetMetricDataMetricDataArray) ElementType

func (GetMetricDataMetricDataArray) ToGetMetricDataMetricDataArrayOutput

func (i GetMetricDataMetricDataArray) ToGetMetricDataMetricDataArrayOutput() GetMetricDataMetricDataArrayOutput

func (GetMetricDataMetricDataArray) ToGetMetricDataMetricDataArrayOutputWithContext

func (i GetMetricDataMetricDataArray) ToGetMetricDataMetricDataArrayOutputWithContext(ctx context.Context) GetMetricDataMetricDataArrayOutput

type GetMetricDataMetricDataArrayInput

type GetMetricDataMetricDataArrayInput interface {
	pulumi.Input

	ToGetMetricDataMetricDataArrayOutput() GetMetricDataMetricDataArrayOutput
	ToGetMetricDataMetricDataArrayOutputWithContext(context.Context) GetMetricDataMetricDataArrayOutput
}

GetMetricDataMetricDataArrayInput is an input type that accepts GetMetricDataMetricDataArray and GetMetricDataMetricDataArrayOutput values. You can construct a concrete instance of `GetMetricDataMetricDataArrayInput` via:

GetMetricDataMetricDataArray{ GetMetricDataMetricDataArgs{...} }

type GetMetricDataMetricDataArrayOutput

type GetMetricDataMetricDataArrayOutput struct{ *pulumi.OutputState }

func (GetMetricDataMetricDataArrayOutput) ElementType

func (GetMetricDataMetricDataArrayOutput) Index

func (GetMetricDataMetricDataArrayOutput) ToGetMetricDataMetricDataArrayOutput

func (o GetMetricDataMetricDataArrayOutput) ToGetMetricDataMetricDataArrayOutput() GetMetricDataMetricDataArrayOutput

func (GetMetricDataMetricDataArrayOutput) ToGetMetricDataMetricDataArrayOutputWithContext

func (o GetMetricDataMetricDataArrayOutput) ToGetMetricDataMetricDataArrayOutputWithContext(ctx context.Context) GetMetricDataMetricDataArrayOutput

type GetMetricDataMetricDataInput

type GetMetricDataMetricDataInput interface {
	pulumi.Input

	ToGetMetricDataMetricDataOutput() GetMetricDataMetricDataOutput
	ToGetMetricDataMetricDataOutputWithContext(context.Context) GetMetricDataMetricDataOutput
}

GetMetricDataMetricDataInput is an input type that accepts GetMetricDataMetricDataArgs and GetMetricDataMetricDataOutput values. You can construct a concrete instance of `GetMetricDataMetricDataInput` via:

GetMetricDataMetricDataArgs{...}

type GetMetricDataMetricDataOutput

type GetMetricDataMetricDataOutput struct{ *pulumi.OutputState }

func (GetMetricDataMetricDataOutput) AggregatedDatapoints

The list of timestamp-value pairs returned for the specified request. Metric values are rolled up to the start time specified in the request. For important limits information related to data points, see MetricData Reference at the top of this page.

func (GetMetricDataMetricDataOutput) CompartmentId

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: `ocid1.compartment.oc1..exampleuniqueID`

func (GetMetricDataMetricDataOutput) CompartmentIdInSubtree

func (o GetMetricDataMetricDataOutput) CompartmentIdInSubtree() pulumi.BoolOutput

When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.

func (GetMetricDataMetricDataOutput) Dimensions

Qualifiers provided in the definition of the returned metric. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`

func (GetMetricDataMetricDataOutput) ElementType

func (GetMetricDataMetricDataOutput) EndTime

The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent. Example: `2019-02-01T02:02:29.600Z`

func (GetMetricDataMetricDataOutput) Metadata

The references provided in a metric definition to indicate extra information about the metric. Example: `"unit": "bytes"`

func (GetMetricDataMetricDataOutput) Name

The name of the metric. Example: `CpuUtilization`

func (GetMetricDataMetricDataOutput) Namespace

The source service or application to use when searching for metric data points to aggregate. Example: `ociComputeagent`

func (GetMetricDataMetricDataOutput) Query

The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.

Construct your query to avoid exceeding limits on returned data. See [MetricData Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/20180401/MetricData).

For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).

Example: `CpuUtilization[1m].sum()`

func (GetMetricDataMetricDataOutput) Resolution

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. Example: `5m`

func (GetMetricDataMetricDataOutput) ResourceGroup

Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`

func (GetMetricDataMetricDataOutput) StartTime

The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent. Example: `2019-02-01T01:02:29.600Z`

func (GetMetricDataMetricDataOutput) ToGetMetricDataMetricDataOutput

func (o GetMetricDataMetricDataOutput) ToGetMetricDataMetricDataOutput() GetMetricDataMetricDataOutput

func (GetMetricDataMetricDataOutput) ToGetMetricDataMetricDataOutputWithContext

func (o GetMetricDataMetricDataOutput) ToGetMetricDataMetricDataOutputWithContext(ctx context.Context) GetMetricDataMetricDataOutput

type GetMetricDataOutputArgs

type GetMetricDataOutputArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId pulumi.StringInput `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree pulumi.BoolPtrInput `pulumi:"compartmentIdInSubtree"`
	// The end of the time range to use when searching for metric data points. Format is defined by RFC3339. The response excludes metric data points for the endTime. Default value: the timestamp representing when the call was sent.  Example: `2019-02-01T02:02:29.600Z`
	EndTime pulumi.StringPtrInput         `pulumi:"endTime"`
	Filters GetMetricDataFilterArrayInput `pulumi:"filters"`
	// The source service or application to use when searching for metric data points to aggregate.  Example: `ociComputeagent`
	Namespace pulumi.StringInput `pulumi:"namespace"`
	// The Monitoring Query Language (MQL) expression to use when searching for metric data points to aggregate. The query must specify a metric, statistic, and interval. Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.
	//
	// Construct your query to avoid exceeding limits on returned data. See [MetricData Reference](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/20180401/MetricData).
	//
	// For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	//
	// Example: `CpuUtilization[1m].sum()`
	Query pulumi.StringInput `pulumi:"query"`
	// The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.  Example: `5m`
	Resolution pulumi.StringPtrInput `pulumi:"resolution"`
	// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup pulumi.StringPtrInput `pulumi:"resourceGroup"`
	// The beginning of the time range to use when searching for metric data points. Format is defined by RFC3339. The response includes metric data points for the startTime. Default value: the timestamp 3 hours before the call was sent.  Example: `2019-02-01T01:02:29.600Z`
	StartTime pulumi.StringPtrInput `pulumi:"startTime"`
}

A collection of arguments for invoking getMetricData.

func (GetMetricDataOutputArgs) ElementType

func (GetMetricDataOutputArgs) ElementType() reflect.Type

type GetMetricDataResult

type GetMetricDataResult struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources from which the aggregated data was returned.
	CompartmentId          string                `pulumi:"compartmentId"`
	CompartmentIdInSubtree *bool                 `pulumi:"compartmentIdInSubtree"`
	EndTime                *string               `pulumi:"endTime"`
	Filters                []GetMetricDataFilter `pulumi:"filters"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The list of metric_data.
	MetricDatas []GetMetricDataMetricData `pulumi:"metricDatas"`
	// The reference provided in a metric definition to indicate the source service or application that emitted the metric.  Example: `ociComputeagent`
	Namespace string `pulumi:"namespace"`
	Query     string `pulumi:"query"`
	// The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`.  Example: `5m`
	Resolution *string `pulumi:"resolution"`
	// Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup *string `pulumi:"resourceGroup"`
	StartTime     *string `pulumi:"startTime"`
}

A collection of values returned by getMetricData.

func GetMetricData

func GetMetricData(ctx *pulumi.Context, args *GetMetricDataArgs, opts ...pulumi.InvokeOption) (*GetMetricDataResult, error)

This data source provides the list of Metric Data in Oracle Cloud Infrastructure Monitoring service.

Returns aggregated data that match the criteria specified in the request. Compartment OCID required. For information on metric queries, see [Building Metric Queries](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/buildingqueries.htm). For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).

Transactions Per Second (TPS) per-tenancy limit for this operation: 10.

## Example Usage

```go 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.GetMetricData(ctx, &monitoring.GetMetricDataArgs{
			CompartmentId:          _var.Compartment_id,
			Namespace:              _var.Metric_data_namespace,
			Query:                  _var.Metric_data_query,
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Metric_data_compartment_id_in_subtree),
			EndTime:                pulumi.StringRef(_var.Metric_data_end_time),
			Resolution:             pulumi.StringRef(_var.Metric_data_resolution),
			ResourceGroup:          pulumi.StringRef(_var.Metric_data_resource_group),
			StartTime:              pulumi.StringRef(_var.Metric_data_start_time),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetMetricDataResultOutput

type GetMetricDataResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getMetricData.

func (GetMetricDataResultOutput) CompartmentId

func (o GetMetricDataResultOutput) CompartmentId() pulumi.StringOutput

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources from which the aggregated data was returned.

func (GetMetricDataResultOutput) CompartmentIdInSubtree

func (o GetMetricDataResultOutput) CompartmentIdInSubtree() pulumi.BoolPtrOutput

func (GetMetricDataResultOutput) ElementType

func (GetMetricDataResultOutput) ElementType() reflect.Type

func (GetMetricDataResultOutput) EndTime

func (GetMetricDataResultOutput) Filters

func (GetMetricDataResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetMetricDataResultOutput) MetricDatas

The list of metric_data.

func (GetMetricDataResultOutput) Namespace

The reference provided in a metric definition to indicate the source service or application that emitted the metric. Example: `ociComputeagent`

func (GetMetricDataResultOutput) Query

func (GetMetricDataResultOutput) Resolution

The time between calculated aggregation windows. Use with the query interval to vary the frequency at which aggregated data points are returned. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal or less than the interval in the query. The default resolution is 1m (one minute). Supported values: `1m`-`60m`, `1h`-`24h`, `1d`. Example: `5m`

func (GetMetricDataResultOutput) ResourceGroup

Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`

func (GetMetricDataResultOutput) StartTime

func (GetMetricDataResultOutput) ToGetMetricDataResultOutput

func (o GetMetricDataResultOutput) ToGetMetricDataResultOutput() GetMetricDataResultOutput

func (GetMetricDataResultOutput) ToGetMetricDataResultOutputWithContext

func (o GetMetricDataResultOutput) ToGetMetricDataResultOutputWithContext(ctx context.Context) GetMetricDataResultOutput

type GetMetricsArgs

type GetMetricsArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId string `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree *bool `pulumi:"compartmentIdInSubtree"`
	// Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.  Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
	DimensionFilters map[string]interface{} `pulumi:"dimensionFilters"`
	Filters          []GetMetricsFilter     `pulumi:"filters"`
	// Group metrics by these fields in the response. For example, to list all metric namespaces available in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup.
	//
	// Example - group by namespace: `[ "namespace" ]`
	GroupBies []string `pulumi:"groupBies"`
	// The metric name to use when searching for metric definitions.  Example: `CpuUtilization`
	Name *string `pulumi:"name"`
	// The source service or application to use when searching for metric definitions.  Example: `ociComputeagent`
	Namespace *string `pulumi:"namespace"`
	// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup *string `pulumi:"resourceGroup"`
}

A collection of arguments for invoking getMetrics.

type GetMetricsFilter

type GetMetricsFilter struct {
	// The metric name to use when searching for metric definitions.  Example: `CpuUtilization`
	Name   string   `pulumi:"name"`
	Regex  *bool    `pulumi:"regex"`
	Values []string `pulumi:"values"`
}

type GetMetricsFilterArgs

type GetMetricsFilterArgs struct {
	// The metric name to use when searching for metric definitions.  Example: `CpuUtilization`
	Name   pulumi.StringInput      `pulumi:"name"`
	Regex  pulumi.BoolPtrInput     `pulumi:"regex"`
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GetMetricsFilterArgs) ElementType

func (GetMetricsFilterArgs) ElementType() reflect.Type

func (GetMetricsFilterArgs) ToGetMetricsFilterOutput

func (i GetMetricsFilterArgs) ToGetMetricsFilterOutput() GetMetricsFilterOutput

func (GetMetricsFilterArgs) ToGetMetricsFilterOutputWithContext

func (i GetMetricsFilterArgs) ToGetMetricsFilterOutputWithContext(ctx context.Context) GetMetricsFilterOutput

type GetMetricsFilterArray

type GetMetricsFilterArray []GetMetricsFilterInput

func (GetMetricsFilterArray) ElementType

func (GetMetricsFilterArray) ElementType() reflect.Type

func (GetMetricsFilterArray) ToGetMetricsFilterArrayOutput

func (i GetMetricsFilterArray) ToGetMetricsFilterArrayOutput() GetMetricsFilterArrayOutput

func (GetMetricsFilterArray) ToGetMetricsFilterArrayOutputWithContext

func (i GetMetricsFilterArray) ToGetMetricsFilterArrayOutputWithContext(ctx context.Context) GetMetricsFilterArrayOutput

type GetMetricsFilterArrayInput

type GetMetricsFilterArrayInput interface {
	pulumi.Input

	ToGetMetricsFilterArrayOutput() GetMetricsFilterArrayOutput
	ToGetMetricsFilterArrayOutputWithContext(context.Context) GetMetricsFilterArrayOutput
}

GetMetricsFilterArrayInput is an input type that accepts GetMetricsFilterArray and GetMetricsFilterArrayOutput values. You can construct a concrete instance of `GetMetricsFilterArrayInput` via:

GetMetricsFilterArray{ GetMetricsFilterArgs{...} }

type GetMetricsFilterArrayOutput

type GetMetricsFilterArrayOutput struct{ *pulumi.OutputState }

func (GetMetricsFilterArrayOutput) ElementType

func (GetMetricsFilterArrayOutput) Index

func (GetMetricsFilterArrayOutput) ToGetMetricsFilterArrayOutput

func (o GetMetricsFilterArrayOutput) ToGetMetricsFilterArrayOutput() GetMetricsFilterArrayOutput

func (GetMetricsFilterArrayOutput) ToGetMetricsFilterArrayOutputWithContext

func (o GetMetricsFilterArrayOutput) ToGetMetricsFilterArrayOutputWithContext(ctx context.Context) GetMetricsFilterArrayOutput

type GetMetricsFilterInput

type GetMetricsFilterInput interface {
	pulumi.Input

	ToGetMetricsFilterOutput() GetMetricsFilterOutput
	ToGetMetricsFilterOutputWithContext(context.Context) GetMetricsFilterOutput
}

GetMetricsFilterInput is an input type that accepts GetMetricsFilterArgs and GetMetricsFilterOutput values. You can construct a concrete instance of `GetMetricsFilterInput` via:

GetMetricsFilterArgs{...}

type GetMetricsFilterOutput

type GetMetricsFilterOutput struct{ *pulumi.OutputState }

func (GetMetricsFilterOutput) ElementType

func (GetMetricsFilterOutput) ElementType() reflect.Type

func (GetMetricsFilterOutput) Name

The metric name to use when searching for metric definitions. Example: `CpuUtilization`

func (GetMetricsFilterOutput) Regex

func (GetMetricsFilterOutput) ToGetMetricsFilterOutput

func (o GetMetricsFilterOutput) ToGetMetricsFilterOutput() GetMetricsFilterOutput

func (GetMetricsFilterOutput) ToGetMetricsFilterOutputWithContext

func (o GetMetricsFilterOutput) ToGetMetricsFilterOutputWithContext(ctx context.Context) GetMetricsFilterOutput

func (GetMetricsFilterOutput) Values

type GetMetricsMetric

type GetMetricsMetric struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId string `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree bool `pulumi:"compartmentIdInSubtree"`
	// Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.  Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
	DimensionFilters map[string]interface{} `pulumi:"dimensionFilters"`
	// Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.  Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
	Dimensions map[string]interface{} `pulumi:"dimensions"`
	// Group metrics by these fields in the response. For example, to list all metric namespaces available in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup.
	//
	// Example - group by namespace: `[ "namespace" ]`
	GroupBies []string `pulumi:"groupBies"`
	// The metric name to use when searching for metric definitions.  Example: `CpuUtilization`
	Name string `pulumi:"name"`
	// The source service or application to use when searching for metric definitions.  Example: `ociComputeagent`
	Namespace string `pulumi:"namespace"`
	// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup string `pulumi:"resourceGroup"`
}

type GetMetricsMetricArgs

type GetMetricsMetricArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId pulumi.StringInput `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree pulumi.BoolInput `pulumi:"compartmentIdInSubtree"`
	// Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.  Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
	DimensionFilters pulumi.MapInput `pulumi:"dimensionFilters"`
	// Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.  Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
	Dimensions pulumi.MapInput `pulumi:"dimensions"`
	// Group metrics by these fields in the response. For example, to list all metric namespaces available in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup.
	//
	// Example - group by namespace: `[ "namespace" ]`
	GroupBies pulumi.StringArrayInput `pulumi:"groupBies"`
	// The metric name to use when searching for metric definitions.  Example: `CpuUtilization`
	Name pulumi.StringInput `pulumi:"name"`
	// The source service or application to use when searching for metric definitions.  Example: `ociComputeagent`
	Namespace pulumi.StringInput `pulumi:"namespace"`
	// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup pulumi.StringInput `pulumi:"resourceGroup"`
}

func (GetMetricsMetricArgs) ElementType

func (GetMetricsMetricArgs) ElementType() reflect.Type

func (GetMetricsMetricArgs) ToGetMetricsMetricOutput

func (i GetMetricsMetricArgs) ToGetMetricsMetricOutput() GetMetricsMetricOutput

func (GetMetricsMetricArgs) ToGetMetricsMetricOutputWithContext

func (i GetMetricsMetricArgs) ToGetMetricsMetricOutputWithContext(ctx context.Context) GetMetricsMetricOutput

type GetMetricsMetricArray

type GetMetricsMetricArray []GetMetricsMetricInput

func (GetMetricsMetricArray) ElementType

func (GetMetricsMetricArray) ElementType() reflect.Type

func (GetMetricsMetricArray) ToGetMetricsMetricArrayOutput

func (i GetMetricsMetricArray) ToGetMetricsMetricArrayOutput() GetMetricsMetricArrayOutput

func (GetMetricsMetricArray) ToGetMetricsMetricArrayOutputWithContext

func (i GetMetricsMetricArray) ToGetMetricsMetricArrayOutputWithContext(ctx context.Context) GetMetricsMetricArrayOutput

type GetMetricsMetricArrayInput

type GetMetricsMetricArrayInput interface {
	pulumi.Input

	ToGetMetricsMetricArrayOutput() GetMetricsMetricArrayOutput
	ToGetMetricsMetricArrayOutputWithContext(context.Context) GetMetricsMetricArrayOutput
}

GetMetricsMetricArrayInput is an input type that accepts GetMetricsMetricArray and GetMetricsMetricArrayOutput values. You can construct a concrete instance of `GetMetricsMetricArrayInput` via:

GetMetricsMetricArray{ GetMetricsMetricArgs{...} }

type GetMetricsMetricArrayOutput

type GetMetricsMetricArrayOutput struct{ *pulumi.OutputState }

func (GetMetricsMetricArrayOutput) ElementType

func (GetMetricsMetricArrayOutput) Index

func (GetMetricsMetricArrayOutput) ToGetMetricsMetricArrayOutput

func (o GetMetricsMetricArrayOutput) ToGetMetricsMetricArrayOutput() GetMetricsMetricArrayOutput

func (GetMetricsMetricArrayOutput) ToGetMetricsMetricArrayOutputWithContext

func (o GetMetricsMetricArrayOutput) ToGetMetricsMetricArrayOutputWithContext(ctx context.Context) GetMetricsMetricArrayOutput

type GetMetricsMetricInput

type GetMetricsMetricInput interface {
	pulumi.Input

	ToGetMetricsMetricOutput() GetMetricsMetricOutput
	ToGetMetricsMetricOutputWithContext(context.Context) GetMetricsMetricOutput
}

GetMetricsMetricInput is an input type that accepts GetMetricsMetricArgs and GetMetricsMetricOutput values. You can construct a concrete instance of `GetMetricsMetricInput` via:

GetMetricsMetricArgs{...}

type GetMetricsMetricOutput

type GetMetricsMetricOutput struct{ *pulumi.OutputState }

func (GetMetricsMetricOutput) CompartmentId

func (o GetMetricsMetricOutput) CompartmentId() pulumi.StringOutput

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: `ocid1.compartment.oc1..exampleuniqueID`

func (GetMetricsMetricOutput) CompartmentIdInSubtree

func (o GetMetricsMetricOutput) CompartmentIdInSubtree() pulumi.BoolOutput

When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.

func (GetMetricsMetricOutput) DimensionFilters

func (o GetMetricsMetricOutput) DimensionFilters() pulumi.MapOutput

Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`

func (GetMetricsMetricOutput) Dimensions

func (o GetMetricsMetricOutput) Dimensions() pulumi.MapOutput

Qualifiers provided in a metric definition. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair. Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`

func (GetMetricsMetricOutput) ElementType

func (GetMetricsMetricOutput) ElementType() reflect.Type

func (GetMetricsMetricOutput) GroupBies

Group metrics by these fields in the response. For example, to list all metric namespaces available in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup.

Example - group by namespace: `[ "namespace" ]`

func (GetMetricsMetricOutput) Name

The metric name to use when searching for metric definitions. Example: `CpuUtilization`

func (GetMetricsMetricOutput) Namespace

The source service or application to use when searching for metric definitions. Example: `ociComputeagent`

func (GetMetricsMetricOutput) ResourceGroup

func (o GetMetricsMetricOutput) ResourceGroup() pulumi.StringOutput

Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`

func (GetMetricsMetricOutput) ToGetMetricsMetricOutput

func (o GetMetricsMetricOutput) ToGetMetricsMetricOutput() GetMetricsMetricOutput

func (GetMetricsMetricOutput) ToGetMetricsMetricOutputWithContext

func (o GetMetricsMetricOutput) ToGetMetricsMetricOutputWithContext(ctx context.Context) GetMetricsMetricOutput

type GetMetricsOutputArgs

type GetMetricsOutputArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.  Example: `ocid1.compartment.oc1..exampleuniqueID`
	CompartmentId pulumi.StringInput `pulumi:"compartmentId"`
	// When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false.
	CompartmentIdInSubtree pulumi.BoolPtrInput `pulumi:"compartmentIdInSubtree"`
	// Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.  Example: `"resourceId": "ocid1.instance.region1.phx.exampleuniqueID"`
	DimensionFilters pulumi.MapInput            `pulumi:"dimensionFilters"`
	Filters          GetMetricsFilterArrayInput `pulumi:"filters"`
	// Group metrics by these fields in the response. For example, to list all metric namespaces available in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup.
	//
	// Example - group by namespace: `[ "namespace" ]`
	GroupBies pulumi.StringArrayInput `pulumi:"groupBies"`
	// The metric name to use when searching for metric definitions.  Example: `CpuUtilization`
	Name pulumi.StringPtrInput `pulumi:"name"`
	// The source service or application to use when searching for metric definitions.  Example: `ociComputeagent`
	Namespace pulumi.StringPtrInput `pulumi:"namespace"`
	// Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup pulumi.StringPtrInput `pulumi:"resourceGroup"`
}

A collection of arguments for invoking getMetrics.

func (GetMetricsOutputArgs) ElementType

func (GetMetricsOutputArgs) ElementType() reflect.Type

type GetMetricsResult

type GetMetricsResult struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric.
	CompartmentId          string                 `pulumi:"compartmentId"`
	CompartmentIdInSubtree *bool                  `pulumi:"compartmentIdInSubtree"`
	DimensionFilters       map[string]interface{} `pulumi:"dimensionFilters"`
	Filters                []GetMetricsFilter     `pulumi:"filters"`
	GroupBies              []string               `pulumi:"groupBies"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The list of metrics.
	Metrics []GetMetricsMetric `pulumi:"metrics"`
	// The name of the metric.  Example: `CpuUtilization`
	Name *string `pulumi:"name"`
	// The source service or application emitting the metric.  Example: `ociComputeagent`
	Namespace *string `pulumi:"namespace"`
	// Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup *string `pulumi:"resourceGroup"`
}

A collection of values returned by getMetrics.

func GetMetrics

func GetMetrics(ctx *pulumi.Context, args *GetMetricsArgs, opts ...pulumi.InvokeOption) (*GetMetricsResult, error)

This data source provides the list of Metrics in Oracle Cloud Infrastructure Monitoring service.

Returns metric definitions that match the criteria specified in the request. Compartment OCID required. For information about metrics, see [Metrics Overview](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview). For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).

Transactions Per Second (TPS) per-tenancy limit for this operation: 10.

## Example Usage

```go 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.GetMetrics(ctx, &monitoring.GetMetricsArgs{
			CompartmentId:          _var.Compartment_id,
			CompartmentIdInSubtree: pulumi.BoolRef(_var.Metric_compartment_id_in_subtree),
			DimensionFilters:       _var.Metric_dimension_filters,
			GroupBies:              _var.Metric_group_by,
			Name:                   pulumi.StringRef(_var.Metric_name),
			Namespace:              pulumi.StringRef(_var.Metric_namespace),
			ResourceGroup:          pulumi.StringRef(_var.Metric_resource_group),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetMetricsResultOutput

type GetMetricsResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getMetrics.

func (GetMetricsResultOutput) CompartmentId

func (o GetMetricsResultOutput) CompartmentId() pulumi.StringOutput

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric.

func (GetMetricsResultOutput) CompartmentIdInSubtree

func (o GetMetricsResultOutput) CompartmentIdInSubtree() pulumi.BoolPtrOutput

func (GetMetricsResultOutput) DimensionFilters

func (o GetMetricsResultOutput) DimensionFilters() pulumi.MapOutput

func (GetMetricsResultOutput) ElementType

func (GetMetricsResultOutput) ElementType() reflect.Type

func (GetMetricsResultOutput) Filters

func (GetMetricsResultOutput) GroupBies

func (GetMetricsResultOutput) Id

The provider-assigned unique ID for this managed resource.

func (GetMetricsResultOutput) Metrics

The list of metrics.

func (GetMetricsResultOutput) Name

The name of the metric. Example: `CpuUtilization`

func (GetMetricsResultOutput) Namespace

The source service or application emitting the metric. Example: `ociComputeagent`

func (GetMetricsResultOutput) ResourceGroup

func (o GetMetricsResultOutput) ResourceGroup() pulumi.StringPtrOutput

Resource group provided with the posted metric. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`

func (GetMetricsResultOutput) ToGetMetricsResultOutput

func (o GetMetricsResultOutput) ToGetMetricsResultOutput() GetMetricsResultOutput

func (GetMetricsResultOutput) ToGetMetricsResultOutputWithContext

func (o GetMetricsResultOutput) ToGetMetricsResultOutputWithContext(ctx context.Context) GetMetricsResultOutput

type LookupAlarmArgs

type LookupAlarmArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
	AlarmId string `pulumi:"alarmId"`
}

A collection of arguments for invoking getAlarm.

type LookupAlarmOutputArgs

type LookupAlarmOutputArgs struct {
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.
	AlarmId pulumi.StringInput `pulumi:"alarmId"`
}

A collection of arguments for invoking getAlarm.

func (LookupAlarmOutputArgs) ElementType

func (LookupAlarmOutputArgs) ElementType() reflect.Type

type LookupAlarmResult

type LookupAlarmResult struct {
	AlarmId string `pulumi:"alarmId"`
	// The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices.  Example: `High CPU usage alert. Follow runbook instructions for resolution.`
	Body string `pulumi:"body"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
	CompartmentId string `pulumi:"compartmentId"`
	// Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
	DefinedTags map[string]interface{} `pulumi:"definedTags"`
	// A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.
	Destinations []string `pulumi:"destinations"`
	// A user-friendly name for the alarm. It does not have to be unique, and it's changeable.
	DisplayName string `pulumi:"displayName"`
	// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
	FreeformTags map[string]interface{} `pulumi:"freeformTags"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
	Id string `pulumi:"id"`
	// Whether the alarm is enabled.  Example: `true`
	IsEnabled bool `pulumi:"isEnabled"`
	// When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`
	IsNotificationsPerMetricDimensionEnabled bool `pulumi:"isNotificationsPerMetricDimensionEnabled"`
	// The format to use for notification messages sent from this alarm. The formats are:
	MessageFormat string `pulumi:"messageFormat"`
	// The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
	MetricCompartmentId string `pulumi:"metricCompartmentId"`
	// When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false.  Example: `true`
	MetricCompartmentIdInSubtree bool `pulumi:"metricCompartmentIdInSubtree"`
	// The source service or application emitting the metric that is evaluated by the alarm.  Example: `ociComputeagent`
	Namespace string `pulumi:"namespace"`
	// The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
	PendingDuration string `pulumi:"pendingDuration"`
	// The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
	Query string `pulumi:"query"`
	// The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.
	RepeatNotificationDuration string `pulumi:"repeatNotificationDuration"`
	// The time between calculated aggregation windows for the alarm. Supported value: `1m`
	Resolution string `pulumi:"resolution"`
	// Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).  Example: `frontend-fleet`
	ResourceGroup string `pulumi:"resourceGroup"`
	// The perceived type of response required when the alarm is in the "FIRING" state.  Example: `CRITICAL`
	Severity string `pulumi:"severity"`
	// The current lifecycle state of the alarm.  Example: `DELETED`
	State string `pulumi:"state"`
	// The configuration details for suppressing an alarm.
	Suppressions []GetAlarmSuppression `pulumi:"suppressions"`
	// The date and time the alarm was created. Format defined by RFC3339.  Example: `2019-02-01T01:02:29.600Z`
	TimeCreated string `pulumi:"timeCreated"`
	// The date and time the alarm was last updated. Format defined by RFC3339.  Example: `2019-02-03T01:02:29.600Z`
	TimeUpdated string `pulumi:"timeUpdated"`
}

A collection of values returned by getAlarm.

func LookupAlarm

func LookupAlarm(ctx *pulumi.Context, args *LookupAlarmArgs, opts ...pulumi.InvokeOption) (*LookupAlarmResult, error)

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

Gets the specified alarm. For important limits information, see [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).

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

```go 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.GetAlarm(ctx, &monitoring.GetAlarmArgs{
			AlarmId: oci_monitoring_alarm.Test_alarm.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupAlarmResultOutput

type LookupAlarmResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getAlarm.

func (LookupAlarmResultOutput) AlarmId

func (LookupAlarmResultOutput) Body

The human-readable content of the notification delivered. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Example: `High CPU usage alert. Follow runbook instructions for resolution.`

func (LookupAlarmResultOutput) CompartmentId

func (o LookupAlarmResultOutput) CompartmentId() pulumi.StringOutput

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.

func (LookupAlarmResultOutput) DefinedTags

func (o LookupAlarmResultOutput) DefinedTags() pulumi.MapOutput

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`

func (LookupAlarmResultOutput) Destinations

A list of destinations to which the notifications for this alarm will be delivered. Each destination is represented by an [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) related to the supported destination service. For example, a destination using the Notifications service is represented by a topic OCID. Supported destination services: Notifications Service. Limit: One destination per supported destination service.

func (LookupAlarmResultOutput) DisplayName

A user-friendly name for the alarm. It does not have to be unique, and it's changeable.

func (LookupAlarmResultOutput) ElementType

func (LookupAlarmResultOutput) ElementType() reflect.Type

func (LookupAlarmResultOutput) FreeformTags

func (o LookupAlarmResultOutput) FreeformTags() pulumi.MapOutput

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

func (LookupAlarmResultOutput) IsEnabled

Whether the alarm is enabled. Example: `true`

func (LookupAlarmResultOutput) IsNotificationsPerMetricDimensionEnabled added in v0.5.0

func (o LookupAlarmResultOutput) IsNotificationsPerMetricDimensionEnabled() pulumi.BoolOutput

When set to `true`, splits notifications per metric stream. When set to `false`, groups notifications across metric streams. Example: `true`

func (LookupAlarmResultOutput) MessageFormat

func (o LookupAlarmResultOutput) MessageFormat() pulumi.StringOutput

The format to use for notification messages sent from this alarm. The formats are:

func (LookupAlarmResultOutput) MetricCompartmentId

func (o LookupAlarmResultOutput) MetricCompartmentId() pulumi.StringOutput

The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.

func (LookupAlarmResultOutput) MetricCompartmentIdInSubtree

func (o LookupAlarmResultOutput) MetricCompartmentIdInSubtree() pulumi.BoolOutput

When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: `true`

func (LookupAlarmResultOutput) Namespace

The source service or application emitting the metric that is evaluated by the alarm. Example: `ociComputeagent`

func (LookupAlarmResultOutput) PendingDuration

func (o LookupAlarmResultOutput) PendingDuration() pulumi.StringOutput

The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".

func (LookupAlarmResultOutput) Query

The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For details about Monitoring Query Language (MQL), see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).

func (LookupAlarmResultOutput) RepeatNotificationDuration

func (o LookupAlarmResultOutput) RepeatNotificationDuration() pulumi.StringOutput

The frequency at which notifications are re-submitted, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.

func (LookupAlarmResultOutput) Resolution

The time between calculated aggregation windows for the alarm. Supported value: `1m`

func (LookupAlarmResultOutput) ResourceGroup

func (o LookupAlarmResultOutput) ResourceGroup() pulumi.StringOutput

Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`

func (LookupAlarmResultOutput) Severity

The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`

func (LookupAlarmResultOutput) State

The current lifecycle state of the alarm. Example: `DELETED`

func (LookupAlarmResultOutput) Suppressions

The configuration details for suppressing an alarm.

func (LookupAlarmResultOutput) TimeCreated

The date and time the alarm was created. Format defined by RFC3339. Example: `2019-02-01T01:02:29.600Z`

func (LookupAlarmResultOutput) TimeUpdated

The date and time the alarm was last updated. Format defined by RFC3339. Example: `2019-02-03T01:02:29.600Z`

func (LookupAlarmResultOutput) ToLookupAlarmResultOutput

func (o LookupAlarmResultOutput) ToLookupAlarmResultOutput() LookupAlarmResultOutput

func (LookupAlarmResultOutput) ToLookupAlarmResultOutputWithContext

func (o LookupAlarmResultOutput) ToLookupAlarmResultOutputWithContext(ctx context.Context) LookupAlarmResultOutput

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL