Docs Packages
  1. Packages
  2. CloudAMQP
  3. API Docs
  4. Alarm
CloudAMQP v3.17.5 published on Friday, Apr 5, 2024 by Pulumi
pulumi/pulumi-cloudamqp

cloudamqp.Alarm

Explore with Pulumi AI

cloudamqp logo
CloudAMQP v3.17.5 published on Friday, Apr 5, 2024 by Pulumi
pulumi/pulumi-cloudamqp

    This resource allows you to create and manage alarms to trigger based on a set of conditions. Once triggerd a notification will be sent to the assigned recipients. When creating a new instance, there will also be a set of default alarms (cpu, memory and disk) created. All default alarms uses the default recipient for notifications.

    By setting no_default_alarms to true in cloudamqp.Instance. This will create the instance without default alarms and avoid the need to import them to get full control.

    Available for all subscription plans, but lemurand tigerare limited to fewer alarm types. The limited types supported can be seen in the table below in Alarm Type Reference.

    Example Usage

    Basic example of CPU and memory alarm
    import * as pulumi from "@pulumi/pulumi";
import * as cloudamqp from "@pulumi/cloudamqp";

// New recipient
const recipient01 = new cloudamqp.Notification("recipient01", {
    instanceId: cloudamqp_instance.instance.id,
    type: "email",
    value: "alarm@example.com",
});
// New cpu alarm
const cpuAlarm = new cloudamqp.Alarm("cpuAlarm", {
    instanceId: cloudamqp_instance.instance.id,
    type: "cpu",
    enabled: true,
    reminderInterval: 600,
    valueThreshold: 95,
    timeThreshold: 600,
    recipients: [recipient01.id],
});
// New memory alarm
const memoryAlarm = new cloudamqp.Alarm("memoryAlarm", {
    instanceId: cloudamqp_instance.instance.id,
    type: "memory",
    enabled: true,
    reminderInterval: 600,
    valueThreshold: 95,
    timeThreshold: 600,
    recipients: [recipient01.id],
});

    import pulumi
import pulumi_cloudamqp as cloudamqp

# New recipient
recipient01 = cloudamqp.Notification("recipient01",
    instance_id=cloudamqp_instance["instance"]["id"],
    type="email",
    value="alarm@example.com")
# New cpu alarm
cpu_alarm = cloudamqp.Alarm("cpuAlarm",
    instance_id=cloudamqp_instance["instance"]["id"],
    type="cpu",
    enabled=True,
    reminder_interval=600,
    value_threshold=95,
    time_threshold=600,
    recipients=[recipient01.id])
# New memory alarm
memory_alarm = cloudamqp.Alarm("memoryAlarm",
    instance_id=cloudamqp_instance["instance"]["id"],
    type="memory",
    enabled=True,
    reminder_interval=600,
    value_threshold=95,
    time_threshold=600,
    recipients=[recipient01.id])

    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 {
		// New recipient
		recipient01, err := cloudamqp.NewNotification(ctx, "recipient01", &cloudamqp.NotificationArgs{
			InstanceId: pulumi.Any(cloudamqp_instance.Instance.Id),
			Type:       pulumi.String("email"),
			Value:      pulumi.String("alarm@example.com"),
		})
		if err != nil {
			return err
		}
		// New cpu alarm
		_, err = cloudamqp.NewAlarm(ctx, "cpuAlarm", &cloudamqp.AlarmArgs{
			InstanceId:       pulumi.Any(cloudamqp_instance.Instance.Id),
			Type:             pulumi.String("cpu"),
			Enabled:          pulumi.Bool(true),
			ReminderInterval: pulumi.Int(600),
			ValueThreshold:   pulumi.Int(95),
			TimeThreshold:    pulumi.Int(600),
			Recipients: pulumi.IntArray{
				recipient01.ID(),
			},
		})
		if err != nil {
			return err
		}
		// New memory alarm
		_, err = cloudamqp.NewAlarm(ctx, "memoryAlarm", &cloudamqp.AlarmArgs{
			InstanceId:       pulumi.Any(cloudamqp_instance.Instance.Id),
			Type:             pulumi.String("memory"),
			Enabled:          pulumi.Bool(true),
			ReminderInterval: pulumi.Int(600),
			ValueThreshold:   pulumi.Int(95),
			TimeThreshold:    pulumi.Int(600),
			Recipients: pulumi.IntArray{
				recipient01.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // New recipient
    var recipient01 = new CloudAmqp.Notification("recipient01", new()
    {
        InstanceId = cloudamqp_instance.Instance.Id,
        Type = "email",
        Value = "alarm@example.com",
    });

    // New cpu alarm
    var cpuAlarm = new CloudAmqp.Alarm("cpuAlarm", new()
    {
        InstanceId = cloudamqp_instance.Instance.Id,
        Type = "cpu",
        Enabled = true,
        ReminderInterval = 600,
        ValueThreshold = 95,
        TimeThreshold = 600,
        Recipients = new[]
        {
            recipient01.Id,
        },
    });

    // New memory alarm
    var memoryAlarm = new CloudAmqp.Alarm("memoryAlarm", new()
    {
        InstanceId = cloudamqp_instance.Instance.Id,
        Type = "memory",
        Enabled = true,
        ReminderInterval = 600,
        ValueThreshold = 95,
        TimeThreshold = 600,
        Recipients = new[]
        {
            recipient01.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudamqp.Notification;
import com.pulumi.cloudamqp.NotificationArgs;
import com.pulumi.cloudamqp.Alarm;
import com.pulumi.cloudamqp.AlarmArgs;
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) {
        // New recipient
        var recipient01 = new Notification("recipient01", NotificationArgs.builder()        
            .instanceId(cloudamqp_instance.instance().id())
            .type("email")
            .value("alarm@example.com")
            .build());

        // New cpu alarm
        var cpuAlarm = new Alarm("cpuAlarm", AlarmArgs.builder()        
            .instanceId(cloudamqp_instance.instance().id())
            .type("cpu")
            .enabled(true)
            .reminderInterval(600)
            .valueThreshold(95)
            .timeThreshold(600)
            .recipients(recipient01.id())
            .build());

        // New memory alarm
        var memoryAlarm = new Alarm("memoryAlarm", AlarmArgs.builder()        
            .instanceId(cloudamqp_instance.instance().id())
            .type("memory")
            .enabled(true)
            .reminderInterval(600)
            .valueThreshold(95)
            .timeThreshold(600)
            .recipients(recipient01.id())
            .build());

    }
}

    resources:
  # New recipient
  recipient01:
    type: cloudamqp:Notification
    properties:
      instanceId: ${cloudamqp_instance.instance.id}
      type: email
      value: alarm@example.com
  # New cpu alarm
  cpuAlarm:
    type: cloudamqp:Alarm
    properties:
      instanceId: ${cloudamqp_instance.instance.id}
      type: cpu
      enabled: true
      reminderInterval: 600
      valueThreshold: 95
      timeThreshold: 600
      recipients:
        - ${recipient01.id}
  # New memory alarm
  memoryAlarm:
    type: cloudamqp:Alarm
    properties:
      instanceId: ${cloudamqp_instance.instance.id}
      type: memory
      enabled: true
      reminderInterval: 600
      valueThreshold: 95
      timeThreshold: 600
      recipients:
        - ${recipient01.id}
    Manage notice alarm, available from v1.29.5

    Only one notice alarm can exists and cannot be created, instead the alarm resource will be updated.

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

// New recipient
const recipient01 = new cloudamqp.Notification("recipient01", {
    instanceId: cloudamqp_instance.instance.id,
    type: "email",
    value: "alarm@example.com",
});
// Update existing notice alarm
const notice = new cloudamqp.Alarm("notice", {
    instanceId: cloudamqp_instance.instance.id,
    type: "notice",
    enabled: true,
    recipients: [recipient01.id],
});

    import pulumi
import pulumi_cloudamqp as cloudamqp

# New recipient
recipient01 = cloudamqp.Notification("recipient01",
    instance_id=cloudamqp_instance["instance"]["id"],
    type="email",
    value="alarm@example.com")
# Update existing notice alarm
notice = cloudamqp.Alarm("notice",
    instance_id=cloudamqp_instance["instance"]["id"],
    type="notice",
    enabled=True,
    recipients=[recipient01.id])

    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 {
		// New recipient
		recipient01, err := cloudamqp.NewNotification(ctx, "recipient01", &cloudamqp.NotificationArgs{
			InstanceId: pulumi.Any(cloudamqp_instance.Instance.Id),
			Type:       pulumi.String("email"),
			Value:      pulumi.String("alarm@example.com"),
		})
		if err != nil {
			return err
		}
		// Update existing notice alarm
		_, err = cloudamqp.NewAlarm(ctx, "notice", &cloudamqp.AlarmArgs{
			InstanceId: pulumi.Any(cloudamqp_instance.Instance.Id),
			Type:       pulumi.String("notice"),
			Enabled:    pulumi.Bool(true),
			Recipients: pulumi.IntArray{
				recipient01.ID(),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // New recipient
    var recipient01 = new CloudAmqp.Notification("recipient01", new()
    {
        InstanceId = cloudamqp_instance.Instance.Id,
        Type = "email",
        Value = "alarm@example.com",
    });

    // Update existing notice alarm
    var notice = new CloudAmqp.Alarm("notice", new()
    {
        InstanceId = cloudamqp_instance.Instance.Id,
        Type = "notice",
        Enabled = true,
        Recipients = new[]
        {
            recipient01.Id,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudamqp.Notification;
import com.pulumi.cloudamqp.NotificationArgs;
import com.pulumi.cloudamqp.Alarm;
import com.pulumi.cloudamqp.AlarmArgs;
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) {
        // New recipient
        var recipient01 = new Notification("recipient01", NotificationArgs.builder()        
            .instanceId(cloudamqp_instance.instance().id())
            .type("email")
            .value("alarm@example.com")
            .build());

        // Update existing notice alarm
        var notice = new Alarm("notice", AlarmArgs.builder()        
            .instanceId(cloudamqp_instance.instance().id())
            .type("notice")
            .enabled(true)
            .recipients(recipient01.id())
            .build());

    }
}

    resources:
  # New recipient
  recipient01:
    type: cloudamqp:Notification
    properties:
      instanceId: ${cloudamqp_instance.instance.id}
      type: email
      value: alarm@example.com
  # Update existing notice alarm
  notice:
    type: cloudamqp:Alarm
    properties:
      instanceId: ${cloudamqp_instance.instance.id}
      type: notice
      enabled: true
      recipients:
        - ${recipient01.id}

    Alarm Type reference

    Supported alarm types: cpu, memory, disk, queue, connection, flow, consumer, netsplit, server_unreachable, notice

    Required arguments for all alarms: instance_id, type, enabled
    Optional argument for all alarms: tags, queue_regex, vhost_regex

    NameTypeSharedDedicatedRequired arguments
    CPUcpu-✔time_threshold, value_threshold
    Memorymemory-✔time_threshold, value_threshold
    Disk spacedisk-✔time_threshold, value_threshold
    Queuequeue✔✔time_threshold, value_threshold, queue_regex, vhost_regex, message_type
    Connectionconnection✔✔time_threshold, value_threshold
    Connection flowflow✔✔time_threshold, value_threshold
    Consumerconsumer✔✔time_threshold, value_threshold, queue, vhost
    Netsplitnetsplit-✔time_threshold
    Server unreachableserver_unreachable-✔time_threshold
    Noticenotice✔✔

    Notice alarm is manadatory! Only one can exists and cannot be deleted. Setting no_default_alarm to true, will still create this alarm. See updated changes to notice alarm below.

    Dependency

    This resource depends on CloudAMQP instance identifier, cloudamqp_instance.instance.id.

    Notice alarm

    There is a limitation for notice alarm in the API backend. This alarm is mandatory, multiple alarms cannot exists or be deleted.

    From provider version v1.29.5 it’s possible to manage the notice alarm and no longer needs to be imported. Just create the alarm resource as usually and it will be updated with given recipients. If the alarm is deleted it will only be removed from the state file, but will still be enabled in the backend.

    Create Alarm Resource

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

    Constructor syntax

    new Alarm(name: string, args: AlarmArgs, opts?: CustomResourceOptions);
    @overload
def Alarm(resource_name: str,
          args: AlarmArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Alarm(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          enabled: Optional[bool] = None,
          instance_id: Optional[int] = None,
          recipients: Optional[Sequence[int]] = None,
          type: Optional[str] = None,
          message_type: Optional[str] = None,
          queue_regex: Optional[str] = None,
          reminder_interval: Optional[int] = None,
          time_threshold: Optional[int] = None,
          value_calculation: Optional[str] = None,
          value_threshold: Optional[int] = None,
          vhost_regex: Optional[str] = None)
    func NewAlarm(ctx *Context, name string, args AlarmArgs, opts ...ResourceOption) (*Alarm, error)
    public Alarm(string name, AlarmArgs args, CustomResourceOptions? opts = null)
    public Alarm(String name, AlarmArgs args)
public Alarm(String name, AlarmArgs args, CustomResourceOptions options)

    type: cloudamqp:Alarm
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AlarmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AlarmArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AlarmArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlarmArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlarmArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var alarmResource = new CloudAmqp.Alarm("alarmResource", new()
{
    Enabled = false,
    InstanceId = 0,
    Recipients = new[]
    {
        0,
    },
    Type = "string",
    MessageType = "string",
    QueueRegex = "string",
    ReminderInterval = 0,
    TimeThreshold = 0,
    ValueCalculation = "string",
    ValueThreshold = 0,
    VhostRegex = "string",
});

    example, err := cloudamqp.NewAlarm(ctx, "alarmResource", &cloudamqp.AlarmArgs{
	Enabled:    pulumi.Bool(false),
	InstanceId: pulumi.Int(0),
	Recipients: pulumi.IntArray{
		pulumi.Int(0),
	},
	Type:             pulumi.String("string"),
	MessageType:      pulumi.String("string"),
	QueueRegex:       pulumi.String("string"),
	ReminderInterval: pulumi.Int(0),
	TimeThreshold:    pulumi.Int(0),
	ValueCalculation: pulumi.String("string"),
	ValueThreshold:   pulumi.Int(0),
	VhostRegex:       pulumi.String("string"),
})

    var alarmResource = new Alarm("alarmResource", AlarmArgs.builder()        
    .enabled(false)
    .instanceId(0)
    .recipients(0)
    .type("string")
    .messageType("string")
    .queueRegex("string")
    .reminderInterval(0)
    .timeThreshold(0)
    .valueCalculation("string")
    .valueThreshold(0)
    .vhostRegex("string")
    .build());

    alarm_resource = cloudamqp.Alarm("alarmResource",
    enabled=False,
    instance_id=0,
    recipients=[0],
    type="string",
    message_type="string",
    queue_regex="string",
    reminder_interval=0,
    time_threshold=0,
    value_calculation="string",
    value_threshold=0,
    vhost_regex="string")

    const alarmResource = new cloudamqp.Alarm("alarmResource", {
    enabled: false,
    instanceId: 0,
    recipients: [0],
    type: "string",
    messageType: "string",
    queueRegex: "string",
    reminderInterval: 0,
    timeThreshold: 0,
    valueCalculation: "string",
    valueThreshold: 0,
    vhostRegex: "string",
});

    type: cloudamqp:Alarm
properties:
    enabled: false
    instanceId: 0
    messageType: string
    queueRegex: string
    recipients:
        - 0
    reminderInterval: 0
    timeThreshold: 0
    type: string
    valueCalculation: string
    valueThreshold: 0
    vhostRegex: string

    Alarm Resource Properties

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

    Inputs

    The Alarm resource accepts the following input properties:

    Enabled bool
    Enable or disable the alarm to trigger.
    InstanceId int
    The CloudAMQP instance ID.
    Recipients List<int>
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    Type string
    The alarm type, see valid options below.
    MessageType string

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    QueueRegex string
    Regex for which queue to check.
    ReminderInterval int
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    TimeThreshold int
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    ValueCalculation string

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    ValueThreshold int
    The value to trigger the alarm for.
    VhostRegex string
    Regex for which vhost to check
    Enabled bool
    Enable or disable the alarm to trigger.
    InstanceId int
    The CloudAMQP instance ID.
    Recipients []int
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    Type string
    The alarm type, see valid options below.
    MessageType string

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    QueueRegex string
    Regex for which queue to check.
    ReminderInterval int
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    TimeThreshold int
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    ValueCalculation string

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    ValueThreshold int
    The value to trigger the alarm for.
    VhostRegex string
    Regex for which vhost to check
    enabled Boolean
    Enable or disable the alarm to trigger.
    instanceId Integer
    The CloudAMQP instance ID.
    recipients List<Integer>
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    type String
    The alarm type, see valid options below.
    messageType String

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    queueRegex String
    Regex for which queue to check.
    reminderInterval Integer
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    timeThreshold Integer
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    valueCalculation String

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    valueThreshold Integer
    The value to trigger the alarm for.
    vhostRegex String
    Regex for which vhost to check
    enabled boolean
    Enable or disable the alarm to trigger.
    instanceId number
    The CloudAMQP instance ID.
    recipients number[]
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    type string
    The alarm type, see valid options below.
    messageType string

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    queueRegex string
    Regex for which queue to check.
    reminderInterval number
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    timeThreshold number
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    valueCalculation string

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    valueThreshold number
    The value to trigger the alarm for.
    vhostRegex string
    Regex for which vhost to check
    enabled bool
    Enable or disable the alarm to trigger.
    instance_id int
    The CloudAMQP instance ID.
    recipients Sequence[int]
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    type str
    The alarm type, see valid options below.
    message_type str

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    queue_regex str
    Regex for which queue to check.
    reminder_interval int
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    time_threshold int
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    value_calculation str

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    value_threshold int
    The value to trigger the alarm for.
    vhost_regex str
    Regex for which vhost to check
    enabled Boolean
    Enable or disable the alarm to trigger.
    instanceId Number
    The CloudAMQP instance ID.
    recipients List<Number>
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    type String
    The alarm type, see valid options below.
    messageType String

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    queueRegex String
    Regex for which queue to check.
    reminderInterval Number
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    timeThreshold Number
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    valueCalculation String

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    valueThreshold Number
    The value to trigger the alarm for.
    vhostRegex String
    Regex for which vhost to check

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Alarm Resource

    Get an existing Alarm resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AlarmState, opts?: CustomResourceOptions): Alarm
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        instance_id: Optional[int] = None,
        message_type: Optional[str] = None,
        queue_regex: Optional[str] = None,
        recipients: Optional[Sequence[int]] = None,
        reminder_interval: Optional[int] = None,
        time_threshold: Optional[int] = None,
        type: Optional[str] = None,
        value_calculation: Optional[str] = None,
        value_threshold: Optional[int] = None,
        vhost_regex: Optional[str] = None) -> Alarm
    func GetAlarm(ctx *Context, name string, id IDInput, state *AlarmState, opts ...ResourceOption) (*Alarm, error)
    public static Alarm Get(string name, Input<string> id, AlarmState? state, CustomResourceOptions? opts = null)
    public static Alarm get(String name, Output<String> id, AlarmState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Enabled bool
    Enable or disable the alarm to trigger.
    InstanceId int
    The CloudAMQP instance ID.
    MessageType string

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    QueueRegex string
    Regex for which queue to check.
    Recipients List<int>
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    ReminderInterval int
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    TimeThreshold int
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    Type string
    The alarm type, see valid options below.
    ValueCalculation string

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    ValueThreshold int
    The value to trigger the alarm for.
    VhostRegex string
    Regex for which vhost to check
    Enabled bool
    Enable or disable the alarm to trigger.
    InstanceId int
    The CloudAMQP instance ID.
    MessageType string

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    QueueRegex string
    Regex for which queue to check.
    Recipients []int
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    ReminderInterval int
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    TimeThreshold int
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    Type string
    The alarm type, see valid options below.
    ValueCalculation string

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    ValueThreshold int
    The value to trigger the alarm for.
    VhostRegex string
    Regex for which vhost to check
    enabled Boolean
    Enable or disable the alarm to trigger.
    instanceId Integer
    The CloudAMQP instance ID.
    messageType String

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    queueRegex String
    Regex for which queue to check.
    recipients List<Integer>
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    reminderInterval Integer
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    timeThreshold Integer
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    type String
    The alarm type, see valid options below.
    valueCalculation String

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    valueThreshold Integer
    The value to trigger the alarm for.
    vhostRegex String
    Regex for which vhost to check
    enabled boolean
    Enable or disable the alarm to trigger.
    instanceId number
    The CloudAMQP instance ID.
    messageType string

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    queueRegex string
    Regex for which queue to check.
    recipients number[]
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    reminderInterval number
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    timeThreshold number
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    type string
    The alarm type, see valid options below.
    valueCalculation string

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    valueThreshold number
    The value to trigger the alarm for.
    vhostRegex string
    Regex for which vhost to check
    enabled bool
    Enable or disable the alarm to trigger.
    instance_id int
    The CloudAMQP instance ID.
    message_type str

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    queue_regex str
    Regex for which queue to check.
    recipients Sequence[int]
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    reminder_interval int
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    time_threshold int
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    type str
    The alarm type, see valid options below.
    value_calculation str

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    value_threshold int
    The value to trigger the alarm for.
    vhost_regex str
    Regex for which vhost to check
    enabled Boolean
    Enable or disable the alarm to trigger.
    instanceId Number
    The CloudAMQP instance ID.
    messageType String

    Message type (total, unacked, ready) used by queue alarm type.

    Specific argument for disk alarm

    queueRegex String
    Regex for which queue to check.
    recipients List<Number>
    Identifier for recipient to be notified. Leave empty to notify all recipients.
    reminderInterval Number
    The reminder interval (in seconds) to resend the alarm if not resolved. Set to 0 for no reminders. The Default is 0.
    timeThreshold Number
    The time interval (in seconds) the value_threshold should be active before triggering an alarm.
    type String
    The alarm type, see valid options below.
    valueCalculation String

    Disk value threshold calculation, fixed, percentage of disk space remaining.

    Based on alarm type, different arguments are flagged as required or optional.

    valueThreshold Number
    The value to trigger the alarm for.
    vhostRegex String
    Regex for which vhost to check

    Import

    cloudamqp_alarm can be imported using CloudAMQP internal identifier of the alarm together (CSV separated) with the instance identifier. To retrieve the alarm identifier, use CloudAMQP API

    $ pulumi import cloudamqp:index/alarm:Alarm alarm <id>,<instance_id>`

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

    Package Details

    Repository
    CloudAMQP pulumi/pulumi-cloudamqp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudamqp Terraform Provider.
    cloudamqp logo
    CloudAMQP v3.17.5 published on Friday, Apr 5, 2024 by Pulumi
    pulumi/pulumi-cloudamqp