opsgenie.getHeartbeat

Explore with Pulumi AI

Opsgenie v1.3.15 published on Tuesday, Apr 29, 2025 by Pulumi

Example Usage

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

const test = opsgenie.getHeartbeat({
    name: "genieheartbeat-existing",
});

import pulumi
import pulumi_opsgenie as opsgenie

test = opsgenie.get_heartbeat(name="genieheartbeat-existing")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opsgenie.LookupHeartbeat(ctx, &opsgenie.LookupHeartbeatArgs{
			Name: "genieheartbeat-existing",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = Opsgenie.GetHeartbeat.Invoke(new()
    {
        Name = "genieheartbeat-existing",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opsgenie.OpsgenieFunctions;
import com.pulumi.opsgenie.inputs.GetHeartbeatArgs;
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 test = OpsgenieFunctions.getHeartbeat(GetHeartbeatArgs.builder()
            .name("genieheartbeat-existing")
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: opsgenie:getHeartbeat
      arguments:
        name: genieheartbeat-existing

Using getHeartbeat

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 getHeartbeat(args: GetHeartbeatArgs, opts?: InvokeOptions): Promise<GetHeartbeatResult>
function getHeartbeatOutput(args: GetHeartbeatOutputArgs, opts?: InvokeOptions): Output<GetHeartbeatResult>

def get_heartbeat(alert_message: Optional[str] = None,
                  alert_priority: Optional[str] = None,
                  alert_tags: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  enabled: Optional[bool] = None,
                  interval: Optional[int] = None,
                  interval_unit: Optional[str] = None,
                  name: Optional[str] = None,
                  owner_team_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetHeartbeatResult
def get_heartbeat_output(alert_message: Optional[pulumi.Input[str]] = None,
                  alert_priority: Optional[pulumi.Input[str]] = None,
                  alert_tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  description: Optional[pulumi.Input[str]] = None,
                  enabled: Optional[pulumi.Input[bool]] = None,
                  interval: Optional[pulumi.Input[int]] = None,
                  interval_unit: Optional[pulumi.Input[str]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  owner_team_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetHeartbeatResult]

func LookupHeartbeat(ctx *Context, args *LookupHeartbeatArgs, opts ...InvokeOption) (*LookupHeartbeatResult, error)
func LookupHeartbeatOutput(ctx *Context, args *LookupHeartbeatOutputArgs, opts ...InvokeOption) LookupHeartbeatResultOutput

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

public static class GetHeartbeat 
{
    public static Task<GetHeartbeatResult> InvokeAsync(GetHeartbeatArgs args, InvokeOptions? opts = null)
    public static Output<GetHeartbeatResult> Invoke(GetHeartbeatInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHeartbeatResult> getHeartbeat(GetHeartbeatArgs args, InvokeOptions options)
public static Output<GetHeartbeatResult> getHeartbeat(GetHeartbeatArgs args, InvokeOptions options)

fn::invoke:
  function: opsgenie:index/getHeartbeat:getHeartbeat
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: Name of the heartbeat
AlertMessage string: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
AlertPriority string: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
AlertTags List<string>: Specifies the alert tags for heartbeat expiration alert.
Description string: An optional description of the heartbeat
Enabled bool: Enable/disable heartbeat monitoring.
Interval int: Specifies how often a heartbeat message should be expected.
IntervalUnit string: Interval specified as minutes, hours or days.
OwnerTeamId string: Owner team of the heartbeat.

Name string: Name of the heartbeat
AlertMessage string: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
AlertPriority string: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
AlertTags []string: Specifies the alert tags for heartbeat expiration alert.
Description string: An optional description of the heartbeat
Enabled bool: Enable/disable heartbeat monitoring.
Interval int: Specifies how often a heartbeat message should be expected.
IntervalUnit string: Interval specified as minutes, hours or days.
OwnerTeamId string: Owner team of the heartbeat.

name String: Name of the heartbeat
alertMessage String: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
alertPriority String: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
alertTags List<String>: Specifies the alert tags for heartbeat expiration alert.
description String: An optional description of the heartbeat
enabled Boolean: Enable/disable heartbeat monitoring.
interval Integer: Specifies how often a heartbeat message should be expected.
intervalUnit String: Interval specified as minutes, hours or days.
ownerTeamId String: Owner team of the heartbeat.

name string: Name of the heartbeat
alertMessage string: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
alertPriority string: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
alertTags string[]: Specifies the alert tags for heartbeat expiration alert.
description string: An optional description of the heartbeat
enabled boolean: Enable/disable heartbeat monitoring.
interval number: Specifies how often a heartbeat message should be expected.
intervalUnit string: Interval specified as minutes, hours or days.
ownerTeamId string: Owner team of the heartbeat.

name str: Name of the heartbeat
alert_message str: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
alert_priority str: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
alert_tags Sequence[str]: Specifies the alert tags for heartbeat expiration alert.
description str: An optional description of the heartbeat
enabled bool: Enable/disable heartbeat monitoring.
interval int: Specifies how often a heartbeat message should be expected.
interval_unit str: Interval specified as minutes, hours or days.
owner_team_id str: Owner team of the heartbeat.

name String: Name of the heartbeat
alertMessage String: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
alertPriority String: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
alertTags List<String>: Specifies the alert tags for heartbeat expiration alert.
description String: An optional description of the heartbeat
enabled Boolean: Enable/disable heartbeat monitoring.
interval Number: Specifies how often a heartbeat message should be expected.
intervalUnit String: Interval specified as minutes, hours or days.
ownerTeamId String: Owner team of the heartbeat.

getHeartbeat Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Name string
AlertMessage string: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
AlertPriority string: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
AlertTags List<string>: Specifies the alert tags for heartbeat expiration alert.
Description string: An optional description of the heartbeat
Enabled bool: Enable/disable heartbeat monitoring.
Interval int: Specifies how often a heartbeat message should be expected.
IntervalUnit string: Interval specified as minutes, hours or days.
OwnerTeamId string: Owner team of the heartbeat.

Id string: The provider-assigned unique ID for this managed resource.
Name string
AlertMessage string: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
AlertPriority string: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
AlertTags []string: Specifies the alert tags for heartbeat expiration alert.
Description string: An optional description of the heartbeat
Enabled bool: Enable/disable heartbeat monitoring.
Interval int: Specifies how often a heartbeat message should be expected.
IntervalUnit string: Interval specified as minutes, hours or days.
OwnerTeamId string: Owner team of the heartbeat.

id String: The provider-assigned unique ID for this managed resource.
name String
alertMessage String: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
alertPriority String: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
alertTags List<String>: Specifies the alert tags for heartbeat expiration alert.
description String: An optional description of the heartbeat
enabled Boolean: Enable/disable heartbeat monitoring.
interval Integer: Specifies how often a heartbeat message should be expected.
intervalUnit String: Interval specified as minutes, hours or days.
ownerTeamId String: Owner team of the heartbeat.

id string: The provider-assigned unique ID for this managed resource.
name string
alertMessage string: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
alertPriority string: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
alertTags string[]: Specifies the alert tags for heartbeat expiration alert.
description string: An optional description of the heartbeat
enabled boolean: Enable/disable heartbeat monitoring.
interval number: Specifies how often a heartbeat message should be expected.
intervalUnit string: Interval specified as minutes, hours or days.
ownerTeamId string: Owner team of the heartbeat.

id str: The provider-assigned unique ID for this managed resource.
name str
alert_message str: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
alert_priority str: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
alert_tags Sequence[str]: Specifies the alert tags for heartbeat expiration alert.
description str: An optional description of the heartbeat
enabled bool: Enable/disable heartbeat monitoring.
interval int: Specifies how often a heartbeat message should be expected.
interval_unit str: Interval specified as minutes, hours or days.
owner_team_id str: Owner team of the heartbeat.

id String: The provider-assigned unique ID for this managed resource.
name String
alertMessage String: Specifies the alert message for heartbeat expiration alert. If this is not provided, default alert message is "HeartbeatName is expired".
alertPriority String: Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3.
alertTags List<String>: Specifies the alert tags for heartbeat expiration alert.
description String: An optional description of the heartbeat
enabled Boolean: Enable/disable heartbeat monitoring.
interval Number: Specifies how often a heartbeat message should be expected.
intervalUnit String: Interval specified as minutes, hours or days.
ownerTeamId String: Owner team of the heartbeat.

Package Details

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

Opsgenie v1.3.15 published on Tuesday, Apr 29, 2025 by Pulumi

pulumi/pulumi-opsgenie

opsgenie.getHeartbeat

On this page

On this page

Example Usage

Using getHeartbeat

getHeartbeat Result

Package Details

On this page

On this page