CloudAMQP v3.21.0, Apr 8 25

CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi

cloudamqp.getAlarm

Explore with Pulumi AI

CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudamqp from "@pulumi/cloudamqp";

const defaultCpuAlarm = cloudamqp.getAlarm({
    instanceId: instance.id,
    type: "cpu",
});

import pulumi
import pulumi_cloudamqp as cloudamqp

default_cpu_alarm = cloudamqp.get_alarm(instance_id=instance["id"],
    type="cpu")

package main

import (
	"github.com/pulumi/pulumi-cloudamqp/sdk/v3/go/cloudamqp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudamqp.LookupAlarm(ctx, &cloudamqp.LookupAlarmArgs{
			InstanceId: instance.Id,
			Type:       pulumi.StringRef("cpu"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using CloudAmqp = Pulumi.CloudAmqp;

return await Deployment.RunAsync(() => 
{
    var defaultCpuAlarm = CloudAmqp.GetAlarm.Invoke(new()
    {
        InstanceId = instance.Id,
        Type = "cpu",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudamqp.CloudamqpFunctions;
import com.pulumi.cloudamqp.inputs.GetAlarmArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var defaultCpuAlarm = CloudamqpFunctions.getAlarm(GetAlarmArgs.builder()
            .instanceId(instance.id())
            .type("cpu")
            .build());

    }
}

variables:
  defaultCpuAlarm:
    fn::invoke:
      function: cloudamqp:getAlarm
      arguments:
        instanceId: ${instance.id}
        type: cpu

Dependency

This data source depends on CloudAMQP instance identifier, cloudamqp_instance.instance.id.

Alarm Types

cpu, memory, disk, queue, connection, flow, consumer, netsplit, server_unreachable, notice

Using getAlarm

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

function getAlarm(args: GetAlarmArgs, opts?: InvokeOptions): Promise<GetAlarmResult>
function getAlarmOutput(args: GetAlarmOutputArgs, opts?: InvokeOptions): Output<GetAlarmResult>

def get_alarm(alarm_id: Optional[int] = None,
              instance_id: Optional[int] = None,
              type: Optional[str] = None,
              value_calculation: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAlarmResult
def get_alarm_output(alarm_id: Optional[pulumi.Input[int]] = None,
              instance_id: Optional[pulumi.Input[int]] = None,
              type: Optional[pulumi.Input[str]] = None,
              value_calculation: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAlarmResult]

func LookupAlarm(ctx *Context, args *LookupAlarmArgs, opts ...InvokeOption) (*LookupAlarmResult, error)
func LookupAlarmOutput(ctx *Context, args *LookupAlarmOutputArgs, opts ...InvokeOption) LookupAlarmResultOutput

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

public static class GetAlarm 
{
    public static Task<GetAlarmResult> InvokeAsync(GetAlarmArgs args, InvokeOptions? opts = null)
    public static Output<GetAlarmResult> Invoke(GetAlarmInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAlarmResult> getAlarm(GetAlarmArgs args, InvokeOptions options)
public static Output<GetAlarmResult> getAlarm(GetAlarmArgs args, InvokeOptions options)

fn::invoke:
  function: cloudamqp:index/getAlarm:getAlarm
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceId int: The CloudAMQP instance identifier.
AlarmId int: The alarm identifier. Either use this or type to give cloudamqp.Alarm necessary information to retrieve the alarm.
Type string: The alarm type. Either use this or alarm_id to give cloudamqp.Alarm necessary information when retrieve the alarm. Supported alarm types.
ValueCalculation string: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

InstanceId int: The CloudAMQP instance identifier.
AlarmId int: The alarm identifier. Either use this or type to give cloudamqp.Alarm necessary information to retrieve the alarm.
Type string: The alarm type. Either use this or alarm_id to give cloudamqp.Alarm necessary information when retrieve the alarm. Supported alarm types.
ValueCalculation string: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

instanceId Integer: The CloudAMQP instance identifier.
alarmId Integer: The alarm identifier. Either use this or type to give cloudamqp.Alarm necessary information to retrieve the alarm.
type String: The alarm type. Either use this or alarm_id to give cloudamqp.Alarm necessary information when retrieve the alarm. Supported alarm types.
valueCalculation String: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

instanceId number: The CloudAMQP instance identifier.
alarmId number: The alarm identifier. Either use this or type to give cloudamqp.Alarm necessary information to retrieve the alarm.
type string: The alarm type. Either use this or alarm_id to give cloudamqp.Alarm necessary information when retrieve the alarm. Supported alarm types.
valueCalculation string: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

instance_id int: The CloudAMQP instance identifier.
alarm_id int: The alarm identifier. Either use this or type to give cloudamqp.Alarm necessary information to retrieve the alarm.
type str: The alarm type. Either use this or alarm_id to give cloudamqp.Alarm necessary information when retrieve the alarm. Supported alarm types.
value_calculation str: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

instanceId Number: The CloudAMQP instance identifier.
alarmId Number: The alarm identifier. Either use this or type to give cloudamqp.Alarm necessary information to retrieve the alarm.
type String: The alarm type. Either use this or alarm_id to give cloudamqp.Alarm necessary information when retrieve the alarm. Supported alarm types.
valueCalculation String: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

getAlarm Result

The following output properties are available:

Enabled bool: Enable/disable status of the alarm.
Id string: The provider-assigned unique ID for this managed resource.
InstanceId int
MessageType string: Message type (total, unacked, ready) used by queue alarm type.
QueueRegex string: Regular expression for which queue to check.
Recipients List<int>: Identifier for recipient to be notified.
ReminderInterval int: The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders.
TimeThreshold int: The time interval (in seconds) the value_threshold should be active before trigger an alarm.
ValueThreshold int: The value threshold that triggers the alarm.
VhostRegex string: Regular expression for which vhost to check
AlarmId int
Type string
ValueCalculation string: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

Enabled bool: Enable/disable status of the alarm.
Id string: The provider-assigned unique ID for this managed resource.
InstanceId int
MessageType string: Message type (total, unacked, ready) used by queue alarm type.
QueueRegex string: Regular expression for which queue to check.
Recipients []int: Identifier for recipient to be notified.
ReminderInterval int: The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders.
TimeThreshold int: The time interval (in seconds) the value_threshold should be active before trigger an alarm.
ValueThreshold int: The value threshold that triggers the alarm.
VhostRegex string: Regular expression for which vhost to check
AlarmId int
Type string
ValueCalculation string: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

enabled Boolean: Enable/disable status of the alarm.
id String: The provider-assigned unique ID for this managed resource.
instanceId Integer
messageType String: Message type (total, unacked, ready) used by queue alarm type.
queueRegex String: Regular expression for which queue to check.
recipients List<Integer>: Identifier for recipient to be notified.
reminderInterval Integer: The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders.
timeThreshold Integer: The time interval (in seconds) the value_threshold should be active before trigger an alarm.
valueThreshold Integer: The value threshold that triggers the alarm.
vhostRegex String: Regular expression for which vhost to check
alarmId Integer
type String
valueCalculation String: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

enabled boolean: Enable/disable status of the alarm.
id string: The provider-assigned unique ID for this managed resource.
instanceId number
messageType string: Message type (total, unacked, ready) used by queue alarm type.
queueRegex string: Regular expression for which queue to check.
recipients number[]: Identifier for recipient to be notified.
reminderInterval number: The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders.
timeThreshold number: The time interval (in seconds) the value_threshold should be active before trigger an alarm.
valueThreshold number: The value threshold that triggers the alarm.
vhostRegex string: Regular expression for which vhost to check
alarmId number
type string
valueCalculation string: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

enabled bool: Enable/disable status of the alarm.
id str: The provider-assigned unique ID for this managed resource.
instance_id int
message_type str: Message type (total, unacked, ready) used by queue alarm type.
queue_regex str: Regular expression for which queue to check.
recipients Sequence[int]: Identifier for recipient to be notified.
reminder_interval int: The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders.
time_threshold int: The time interval (in seconds) the value_threshold should be active before trigger an alarm.
value_threshold int: The value threshold that triggers the alarm.
vhost_regex str: Regular expression for which vhost to check
alarm_id int
type str
value_calculation str: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

enabled Boolean: Enable/disable status of the alarm.
id String: The provider-assigned unique ID for this managed resource.
instanceId Number
messageType String: Message type (total, unacked, ready) used by queue alarm type.
queueRegex String: Regular expression for which queue to check.
recipients List<Number>: Identifier for recipient to be notified.
reminderInterval Number: The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders.
timeThreshold Number: The time interval (in seconds) the value_threshold should be active before trigger an alarm.
valueThreshold Number: The value threshold that triggers the alarm.
vhostRegex String: Regular expression for which vhost to check
alarmId Number
type String
valueCalculation String: Disk value threshold calculation, (fixed, percentage) of disk space remaining.

Package Details

Repository: CloudAMQP pulumi/pulumi-cloudamqp
License: Apache-2.0
Notes: This Pulumi package is based on the cloudamqp Terraform Provider.

CloudAMQP v3.21.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-cloudamqp

cloudamqp.getAlarm

On this page

On this page

Example Usage

Dependency

Alarm Types

Using getAlarm

getAlarm Result

Package Details

On this page

On this page