Rancher 2 v6.1.1 published on Friday, May 10, 2024 by Pulumi
rancher2.getClusterAlertGroup
Explore with Pulumi AI
Use this data source to retrieve information about a Rancher v2 cluster alert group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";
const foo = rancher2.getClusterAlertGroup({
    clusterId: "<cluster_id>",
    name: "<cluster_alert_group_name>",
});
import pulumi
import pulumi_rancher2 as rancher2
foo = rancher2.get_cluster_alert_group(cluster_id="<cluster_id>",
    name="<cluster_alert_group_name>")
package main
import (
	"github.com/pulumi/pulumi-rancher2/sdk/v6/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
	})
}
using System.Collections.Generic;
using System.Linq;
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 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());
    }
}
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 dictionaryThe following arguments are supported:
- cluster_id str
- The cluster id where create cluster alert group (string)
- name str
- 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)
- GroupInterval intSeconds 
- (Computed) The cluster alert group interval seconds. Default: 180(int)
- GroupWait intSeconds 
- (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<GetCluster Alert Group Recipient> 
- (Computed) The cluster alert group recipients (list)
- RepeatInterval intSeconds 
- (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)
- GroupInterval intSeconds 
- (Computed) The cluster alert group interval seconds. Default: 180(int)
- GroupWait intSeconds 
- (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
[]GetCluster Alert Group Recipient 
- (Computed) The cluster alert group recipients (list)
- RepeatInterval intSeconds 
- (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)
- groupInterval IntegerSeconds 
- (Computed) The cluster alert group interval seconds. Default: 180(int)
- groupWait IntegerSeconds 
- (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<GetCluster Alert Group Recipient> 
- (Computed) The cluster alert group recipients (list)
- repeatInterval IntegerSeconds 
- (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)
- groupInterval numberSeconds 
- (Computed) The cluster alert group interval seconds. Default: 180(int)
- groupWait numberSeconds 
- (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
GetCluster Alert Group Recipient[] 
- (Computed) The cluster alert group recipients (list)
- repeatInterval numberSeconds 
- (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_ intseconds 
- (Computed) The cluster alert group interval seconds. Default: 180(int)
- group_wait_ intseconds 
- (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[GetCluster Alert Group Recipient] 
- (Computed) The cluster alert group recipients (list)
- repeat_interval_ intseconds 
- (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)
- groupInterval NumberSeconds 
- (Computed) The cluster alert group interval seconds. Default: 180(int)
- groupWait NumberSeconds 
- (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)
- repeatInterval NumberSeconds 
- (Computed) The cluster alert group wait seconds. Default: 3600(int)
Supporting Types
GetClusterAlertGroupRecipient    
- NotifierId string
- Recipient notifier ID
- NotifierType string
- Recipient notifier type
- Recipient string
- Recipient
- DefaultRecipient bool
- Use notifier default recipient
- NotifierId string
- Recipient notifier ID
- NotifierType string
- Recipient notifier type
- Recipient string
- Recipient
- DefaultRecipient bool
- Use notifier default recipient
- notifierId String
- Recipient notifier ID
- notifierType String
- Recipient notifier type
- recipient String
- Recipient
- defaultRecipient Boolean
- Use notifier default recipient
- notifierId string
- Recipient notifier ID
- notifierType string
- Recipient notifier type
- recipient string
- Recipient
- defaultRecipient boolean
- Use notifier default recipient
- notifier_id str
- Recipient notifier ID
- notifier_type str
- Recipient notifier type
- recipient str
- Recipient
- default_recipient bool
- Use notifier default recipient
- notifierId String
- Recipient notifier ID
- notifierType String
- Recipient notifier type
- recipient String
- Recipient
- defaultRecipient Boolean
- Use notifier default recipient
Package Details
- Repository
- Rancher2 pulumi/pulumi-rancher2
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the rancher2Terraform Provider.