Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pagerduty Provider
  3. API Docs
  4. getAlertGroupingSetting
PagerDuty v4.23.2 published on Wednesday, Apr 23, 2025 by Pulumi
pulumi/pulumi-pagerduty

pagerduty.getAlertGroupingSetting

Explore with Pulumi AI

pagerduty logo
PagerDuty v4.23.2 published on Wednesday, Apr 23, 2025 by Pulumi
pulumi/pulumi-pagerduty

    Use this data source to get information about a specific alert grouping setting.

    Example Usage

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

const example = pagerduty.getAlertGroupingSetting({
    name: "My example setting",
});

    import pulumi
import pulumi_pagerduty as pagerduty

example = pagerduty.get_alert_grouping_setting(name="My example setting")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := pagerduty.LookupAlertGroupingSetting(ctx, &pagerduty.LookupAlertGroupingSettingArgs{
			Name: "My example setting",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Pagerduty.GetAlertGroupingSetting.Invoke(new()
    {
        Name = "My example setting",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.pagerduty.PagerdutyFunctions;
import com.pulumi.pagerduty.inputs.GetAlertGroupingSettingArgs;
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 example = PagerdutyFunctions.getAlertGroupingSetting(GetAlertGroupingSettingArgs.builder()
            .name("My example setting")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: pagerduty:getAlertGroupingSetting
      arguments:
        name: My example setting

    Using getAlertGroupingSetting

    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 getAlertGroupingSetting(args: GetAlertGroupingSettingArgs, opts?: InvokeOptions): Promise<GetAlertGroupingSettingResult>
function getAlertGroupingSettingOutput(args: GetAlertGroupingSettingOutputArgs, opts?: InvokeOptions): Output<GetAlertGroupingSettingResult>
    def get_alert_grouping_setting(config: Optional[GetAlertGroupingSettingConfig] = None,
                               name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetAlertGroupingSettingResult
def get_alert_grouping_setting_output(config: Optional[pulumi.Input[GetAlertGroupingSettingConfigArgs]] = None,
                               name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetAlertGroupingSettingResult]
    func LookupAlertGroupingSetting(ctx *Context, args *LookupAlertGroupingSettingArgs, opts ...InvokeOption) (*LookupAlertGroupingSettingResult, error)
func LookupAlertGroupingSettingOutput(ctx *Context, args *LookupAlertGroupingSettingOutputArgs, opts ...InvokeOption) LookupAlertGroupingSettingResultOutput

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

    public static class GetAlertGroupingSetting 
{
    public static Task<GetAlertGroupingSettingResult> InvokeAsync(GetAlertGroupingSettingArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertGroupingSettingResult> Invoke(GetAlertGroupingSettingInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAlertGroupingSettingResult> getAlertGroupingSetting(GetAlertGroupingSettingArgs args, InvokeOptions options)
public static Output<GetAlertGroupingSettingResult> getAlertGroupingSetting(GetAlertGroupingSettingArgs args, InvokeOptions options)

    fn::invoke:
  function: pagerduty:index/getAlertGroupingSetting:getAlertGroupingSetting
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name to use to find an alert grouping setting in the PagerDuty API.
    Config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    Name string
    The name to use to find an alert grouping setting in the PagerDuty API.
    Config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    name String
    The name to use to find an alert grouping setting in the PagerDuty API.
    config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    name string
    The name to use to find an alert grouping setting in the PagerDuty API.
    config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    name str
    The name to use to find an alert grouping setting in the PagerDuty API.
    config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    name String
    The name to use to find an alert grouping setting in the PagerDuty API.
    config Property Map
    The values for the configuration setup for this setting.

    getAlertGroupingSetting Result

    The following output properties are available:

    Description string
    A description of this alert grouping setting.
    Id string
    The ID of the found alert grouping setting.
    Name string
    The short name of the found alert grouping setting.
    Services List<string>
    A list of string containing the IDs of services associated with this setting.
    Type string
    The type of object. The value returned will be one of content_based, content_based_intelligent, intelligent or time.
    Config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    Description string
    A description of this alert grouping setting.
    Id string
    The ID of the found alert grouping setting.
    Name string
    The short name of the found alert grouping setting.
    Services []string
    A list of string containing the IDs of services associated with this setting.
    Type string
    The type of object. The value returned will be one of content_based, content_based_intelligent, intelligent or time.
    Config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    description String
    A description of this alert grouping setting.
    id String
    The ID of the found alert grouping setting.
    name String
    The short name of the found alert grouping setting.
    services List<String>
    A list of string containing the IDs of services associated with this setting.
    type String
    The type of object. The value returned will be one of content_based, content_based_intelligent, intelligent or time.
    config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    description string
    A description of this alert grouping setting.
    id string
    The ID of the found alert grouping setting.
    name string
    The short name of the found alert grouping setting.
    services string[]
    A list of string containing the IDs of services associated with this setting.
    type string
    The type of object. The value returned will be one of content_based, content_based_intelligent, intelligent or time.
    config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    description str
    A description of this alert grouping setting.
    id str
    The ID of the found alert grouping setting.
    name str
    The short name of the found alert grouping setting.
    services Sequence[str]
    A list of string containing the IDs of services associated with this setting.
    type str
    The type of object. The value returned will be one of content_based, content_based_intelligent, intelligent or time.
    config GetAlertGroupingSettingConfig
    The values for the configuration setup for this setting.
    description String
    A description of this alert grouping setting.
    id String
    The ID of the found alert grouping setting.
    name String
    The short name of the found alert grouping setting.
    services List<String>
    A list of string containing the IDs of services associated with this setting.
    type String
    The type of object. The value returned will be one of content_based, content_based_intelligent, intelligent or time.
    config Property Map
    The values for the configuration setup for this setting.

    Supporting Types

    GetAlertGroupingSettingConfig

    TimeWindow int
    The maximum amount of time allowed between Alerts. This setting applies only when type is set to intelligent, content_based, content_based_intelligent. Value must be between 300 and 3600 or exactly 86400 (86400 is supported only for content_based alert grouping). Any Alerts arriving greater than time_window seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the recommended time window leave this value unset or set it to null.
    Timeout int
    The duration in minutes within which to automatically group incoming alerts. This setting is only required and applies when type is set to time. To continue grouping alerts until the incident is resolved leave this value unset or set it to null.
    Aggregate string
    One of any or all. This setting is only required and applies when type is set to content_based or content_based_intelligent. Group alerts based on one or all of fields value(s).
    Fields List<string>
    Alerts will be grouped together if the content of these fields match. This setting is only required and applies when type is set to content_based or content_based_intelligent.
    TimeWindow int
    The maximum amount of time allowed between Alerts. This setting applies only when type is set to intelligent, content_based, content_based_intelligent. Value must be between 300 and 3600 or exactly 86400 (86400 is supported only for content_based alert grouping). Any Alerts arriving greater than time_window seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the recommended time window leave this value unset or set it to null.
    Timeout int
    The duration in minutes within which to automatically group incoming alerts. This setting is only required and applies when type is set to time. To continue grouping alerts until the incident is resolved leave this value unset or set it to null.
    Aggregate string
    One of any or all. This setting is only required and applies when type is set to content_based or content_based_intelligent. Group alerts based on one or all of fields value(s).
    Fields []string
    Alerts will be grouped together if the content of these fields match. This setting is only required and applies when type is set to content_based or content_based_intelligent.
    timeWindow Integer
    The maximum amount of time allowed between Alerts. This setting applies only when type is set to intelligent, content_based, content_based_intelligent. Value must be between 300 and 3600 or exactly 86400 (86400 is supported only for content_based alert grouping). Any Alerts arriving greater than time_window seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the recommended time window leave this value unset or set it to null.
    timeout Integer
    The duration in minutes within which to automatically group incoming alerts. This setting is only required and applies when type is set to time. To continue grouping alerts until the incident is resolved leave this value unset or set it to null.
    aggregate String
    One of any or all. This setting is only required and applies when type is set to content_based or content_based_intelligent. Group alerts based on one or all of fields value(s).
    fields List<String>
    Alerts will be grouped together if the content of these fields match. This setting is only required and applies when type is set to content_based or content_based_intelligent.
    timeWindow number
    The maximum amount of time allowed between Alerts. This setting applies only when type is set to intelligent, content_based, content_based_intelligent. Value must be between 300 and 3600 or exactly 86400 (86400 is supported only for content_based alert grouping). Any Alerts arriving greater than time_window seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the recommended time window leave this value unset or set it to null.
    timeout number
    The duration in minutes within which to automatically group incoming alerts. This setting is only required and applies when type is set to time. To continue grouping alerts until the incident is resolved leave this value unset or set it to null.
    aggregate string
    One of any or all. This setting is only required and applies when type is set to content_based or content_based_intelligent. Group alerts based on one or all of fields value(s).
    fields string[]
    Alerts will be grouped together if the content of these fields match. This setting is only required and applies when type is set to content_based or content_based_intelligent.
    time_window int
    The maximum amount of time allowed between Alerts. This setting applies only when type is set to intelligent, content_based, content_based_intelligent. Value must be between 300 and 3600 or exactly 86400 (86400 is supported only for content_based alert grouping). Any Alerts arriving greater than time_window seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the recommended time window leave this value unset or set it to null.
    timeout int
    The duration in minutes within which to automatically group incoming alerts. This setting is only required and applies when type is set to time. To continue grouping alerts until the incident is resolved leave this value unset or set it to null.
    aggregate str
    One of any or all. This setting is only required and applies when type is set to content_based or content_based_intelligent. Group alerts based on one or all of fields value(s).
    fields Sequence[str]
    Alerts will be grouped together if the content of these fields match. This setting is only required and applies when type is set to content_based or content_based_intelligent.
    timeWindow Number
    The maximum amount of time allowed between Alerts. This setting applies only when type is set to intelligent, content_based, content_based_intelligent. Value must be between 300 and 3600 or exactly 86400 (86400 is supported only for content_based alert grouping). Any Alerts arriving greater than time_window seconds apart will not be grouped together. This is a rolling time window and is counted from the most recently grouped alert. The window is extended every time a new alert is added to the group, up to 24 hours. To use the recommended time window leave this value unset or set it to null.
    timeout Number
    The duration in minutes within which to automatically group incoming alerts. This setting is only required and applies when type is set to time. To continue grouping alerts until the incident is resolved leave this value unset or set it to null.
    aggregate String
    One of any or all. This setting is only required and applies when type is set to content_based or content_based_intelligent. Group alerts based on one or all of fields value(s).
    fields List<String>
    Alerts will be grouped together if the content of these fields match. This setting is only required and applies when type is set to content_based or content_based_intelligent.

    Package Details

    Repository
    PagerDuty pulumi/pulumi-pagerduty
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pagerduty Terraform Provider.
    pagerduty logo
    PagerDuty v4.23.2 published on Wednesday, Apr 23, 2025 by Pulumi
    pulumi/pulumi-pagerduty