Rancher 2 v3.9.0, Jan 18 23

rancher2.getClusterAlertGroup

Use this data source to retrieve information about a Rancher v2 cluster alert group.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Rancher2 = Pulumi.Rancher2;

return await Deployment.RunAsync(() => 
{
    var foo = Rancher2.GetClusterAlertGroup.Invoke(new()
    {
        ClusterId = "<cluster_id>",
        Name = "<cluster_alert_group_name>",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.LookupClusterAlertGroup(ctx, &rancher2.LookupClusterAlertGroupArgs{
			ClusterId: "<cluster_id>",
			Name:      "<cluster_alert_group_name>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.Rancher2Functions;
import com.pulumi.rancher2.inputs.GetClusterAlertGroupArgs;
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 foo = Rancher2Functions.getClusterAlertGroup(GetClusterAlertGroupArgs.builder()
            .clusterId("<cluster_id>")
            .name("<cluster_alert_group_name>")
            .build());

    }
}

import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.get_cluster_alert_group(cluster_id="<cluster_id>",
    name="<cluster_alert_group_name>")

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

const foo = rancher2.getClusterAlertGroup({
    clusterId: "<cluster_id>",
    name: "<cluster_alert_group_name>",
});

variables:
  foo:
    fn::invoke:
      Function: rancher2:getClusterAlertGroup
      Arguments:
        clusterId: <cluster_id>
        name: <cluster_alert_group_name>

Using getClusterAlertGroup

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 getClusterAlertGroup(args: GetClusterAlertGroupArgs, opts?: InvokeOptions): Promise<GetClusterAlertGroupResult>
function getClusterAlertGroupOutput(args: GetClusterAlertGroupOutputArgs, opts?: InvokeOptions): Output<GetClusterAlertGroupResult>

def get_cluster_alert_group(cluster_id: Optional[str] = None,
                            name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetClusterAlertGroupResult
def get_cluster_alert_group_output(cluster_id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetClusterAlertGroupResult]

func LookupClusterAlertGroup(ctx *Context, args *LookupClusterAlertGroupArgs, opts ...InvokeOption) (*LookupClusterAlertGroupResult, error)
func LookupClusterAlertGroupOutput(ctx *Context, args *LookupClusterAlertGroupOutputArgs, opts ...InvokeOption) LookupClusterAlertGroupResultOutput

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

public static class GetClusterAlertGroup 
{
    public static Task<GetClusterAlertGroupResult> InvokeAsync(GetClusterAlertGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterAlertGroupResult> Invoke(GetClusterAlertGroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetClusterAlertGroupResult> getClusterAlertGroup(GetClusterAlertGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: rancher2:index/getClusterAlertGroup:getClusterAlertGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterId string: The cluster id where create cluster alert group (string)
Name string: The cluster alert group name (string)

ClusterId string: The cluster id where create cluster alert group (string)
Name string: The cluster alert group name (string)

clusterId String: The cluster id where create cluster alert group (string)
name String: The cluster alert group name (string)

clusterId string: The cluster id where create cluster alert group (string)
name string: The cluster alert group name (string)

cluster_id str: The cluster id where create cluster alert group (string)
name str: The cluster alert group name (string)

clusterId String: The cluster id where create cluster alert group (string)
name String: The cluster alert group name (string)

getClusterAlertGroup Result

The following output properties are available:

Annotations Dictionary<string, object>: (Computed) The cluster alert group annotations (map)
ClusterId string
Description string: (Computed) The cluster alert group description (string)
GroupIntervalSeconds int: (Computed) The cluster alert group interval seconds. Default: 180 (int)
GroupWaitSeconds int: (Computed) The cluster alert group wait seconds. Default: 180 (int)
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, object>: (Computed) The cluster alert group labels (map)
Name string
Recipients List<GetClusterAlertGroupRecipient>: (Computed) The cluster alert group recipients (list)
RepeatIntervalSeconds int: (Computed) The cluster alert group wait seconds. Default: 3600 (int)

Annotations map[string]interface{}: (Computed) The cluster alert group annotations (map)
ClusterId string
Description string: (Computed) The cluster alert group description (string)
GroupIntervalSeconds int: (Computed) The cluster alert group interval seconds. Default: 180 (int)
GroupWaitSeconds int: (Computed) The cluster alert group wait seconds. Default: 180 (int)
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]interface{}: (Computed) The cluster alert group labels (map)
Name string
Recipients []GetClusterAlertGroupRecipient: (Computed) The cluster alert group recipients (list)
RepeatIntervalSeconds int: (Computed) The cluster alert group wait seconds. Default: 3600 (int)

annotations Map<String,Object>: (Computed) The cluster alert group annotations (map)
clusterId String
description String: (Computed) The cluster alert group description (string)
groupIntervalSeconds Integer: (Computed) The cluster alert group interval seconds. Default: 180 (int)
groupWaitSeconds Integer: (Computed) The cluster alert group wait seconds. Default: 180 (int)
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,Object>: (Computed) The cluster alert group labels (map)
name String
recipients List<GetClusterAlertGroupRecipient>: (Computed) The cluster alert group recipients (list)
repeatIntervalSeconds Integer: (Computed) The cluster alert group wait seconds. Default: 3600 (int)

annotations {[key: string]: any}: (Computed) The cluster alert group annotations (map)
clusterId string
description string: (Computed) The cluster alert group description (string)
groupIntervalSeconds number: (Computed) The cluster alert group interval seconds. Default: 180 (int)
groupWaitSeconds number: (Computed) The cluster alert group wait seconds. Default: 180 (int)
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: any}: (Computed) The cluster alert group labels (map)
name string
recipients GetClusterAlertGroupRecipient[]: (Computed) The cluster alert group recipients (list)
repeatIntervalSeconds number: (Computed) The cluster alert group wait seconds. Default: 3600 (int)

annotations Mapping[str, Any]: (Computed) The cluster alert group annotations (map)
cluster_id str
description str: (Computed) The cluster alert group description (string)
group_interval_seconds int: (Computed) The cluster alert group interval seconds. Default: 180 (int)
group_wait_seconds int: (Computed) The cluster alert group wait seconds. Default: 180 (int)
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, Any]: (Computed) The cluster alert group labels (map)
name str
recipients Sequence[GetClusterAlertGroupRecipient]: (Computed) The cluster alert group recipients (list)
repeat_interval_seconds int: (Computed) The cluster alert group wait seconds. Default: 3600 (int)

annotations Map<Any>: (Computed) The cluster alert group annotations (map)
clusterId String
description String: (Computed) The cluster alert group description (string)
groupIntervalSeconds Number: (Computed) The cluster alert group interval seconds. Default: 180 (int)
groupWaitSeconds Number: (Computed) The cluster alert group wait seconds. Default: 180 (int)
id String: The provider-assigned unique ID for this managed resource.
labels Map<Any>: (Computed) The cluster alert group labels (map)
name String
recipients List<Property Map>: (Computed) The cluster alert group recipients (list)
repeatIntervalSeconds Number: (Computed) The cluster alert group wait seconds. Default: 3600 (int)