1. Packages
  2. stackit
  3. API Docs
  4. getObservabilityAlertgroup
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.getObservabilityAlertgroup

stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    Observability alert group datasource schema. Used to create alerts based on metrics (Thanos). Must have a region specified in the provider configuration.

    Example Usage

    data "stackit_observability_alertgroup" "example" {
  project_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  name        = "example-alert-group"
}

    Using getObservabilityAlertgroup

    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 getObservabilityAlertgroup(args: GetObservabilityAlertgroupArgs, opts?: InvokeOptions): Promise<GetObservabilityAlertgroupResult>
function getObservabilityAlertgroupOutput(args: GetObservabilityAlertgroupOutputArgs, opts?: InvokeOptions): Output<GetObservabilityAlertgroupResult>
    def get_observability_alertgroup(instance_id: Optional[str] = None,
                                 name: Optional[str] = None,
                                 project_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetObservabilityAlertgroupResult
def get_observability_alertgroup_output(instance_id: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 project_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetObservabilityAlertgroupResult]
    func LookupObservabilityAlertgroup(ctx *Context, args *LookupObservabilityAlertgroupArgs, opts ...InvokeOption) (*LookupObservabilityAlertgroupResult, error)
func LookupObservabilityAlertgroupOutput(ctx *Context, args *LookupObservabilityAlertgroupOutputArgs, opts ...InvokeOption) LookupObservabilityAlertgroupResultOutput

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

    public static class GetObservabilityAlertgroup 
{
    public static Task<GetObservabilityAlertgroupResult> InvokeAsync(GetObservabilityAlertgroupArgs args, InvokeOptions? opts = null)
    public static Output<GetObservabilityAlertgroupResult> Invoke(GetObservabilityAlertgroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetObservabilityAlertgroupResult> getObservabilityAlertgroup(GetObservabilityAlertgroupArgs args, InvokeOptions options)
public static Output<GetObservabilityAlertgroupResult> getObservabilityAlertgroup(GetObservabilityAlertgroupArgs args, InvokeOptions options)

    fn::invoke:
  function: stackit:index/getObservabilityAlertgroup:getObservabilityAlertgroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Observability instance ID to which the alert group is associated.
    Name string
    The name of the alert group. Is the identifier and must be unique in the group.
    ProjectId string
    STACKIT project ID to which the alert group is associated.
    InstanceId string
    Observability instance ID to which the alert group is associated.
    Name string
    The name of the alert group. Is the identifier and must be unique in the group.
    ProjectId string
    STACKIT project ID to which the alert group is associated.
    instanceId String
    Observability instance ID to which the alert group is associated.
    name String
    The name of the alert group. Is the identifier and must be unique in the group.
    projectId String
    STACKIT project ID to which the alert group is associated.
    instanceId string
    Observability instance ID to which the alert group is associated.
    name string
    The name of the alert group. Is the identifier and must be unique in the group.
    projectId string
    STACKIT project ID to which the alert group is associated.
    instance_id str
    Observability instance ID to which the alert group is associated.
    name str
    The name of the alert group. Is the identifier and must be unique in the group.
    project_id str
    STACKIT project ID to which the alert group is associated.
    instanceId String
    Observability instance ID to which the alert group is associated.
    name String
    The name of the alert group. Is the identifier and must be unique in the group.
    projectId String
    STACKIT project ID to which the alert group is associated.

    getObservabilityAlertgroup Result

    The following output properties are available:

    Id string
    InstanceId string
    Observability instance ID to which the alert group is associated.
    Interval string
    Specifies the frequency at which rules within the group are evaluated. The interval must be at least 60 seconds and defaults to 60 seconds if not set. Supported formats include hours, minutes, and seconds, either singly or in combination. Examples of valid formats are: '5h30m40s', '5h', '5h30m', '60m', and '60s'.
    Name string
    The name of the alert group. Is the identifier and must be unique in the group.
    ProjectId string
    STACKIT project ID to which the alert group is associated.
    Rules List<GetObservabilityAlertgroupRule>
    Id string
    InstanceId string
    Observability instance ID to which the alert group is associated.
    Interval string
    Specifies the frequency at which rules within the group are evaluated. The interval must be at least 60 seconds and defaults to 60 seconds if not set. Supported formats include hours, minutes, and seconds, either singly or in combination. Examples of valid formats are: '5h30m40s', '5h', '5h30m', '60m', and '60s'.
    Name string
    The name of the alert group. Is the identifier and must be unique in the group.
    ProjectId string
    STACKIT project ID to which the alert group is associated.
    Rules []GetObservabilityAlertgroupRule
    id String
    instanceId String
    Observability instance ID to which the alert group is associated.
    interval String
    Specifies the frequency at which rules within the group are evaluated. The interval must be at least 60 seconds and defaults to 60 seconds if not set. Supported formats include hours, minutes, and seconds, either singly or in combination. Examples of valid formats are: '5h30m40s', '5h', '5h30m', '60m', and '60s'.
    name String
    The name of the alert group. Is the identifier and must be unique in the group.
    projectId String
    STACKIT project ID to which the alert group is associated.
    rules List<GetObservabilityAlertgroupRule>
    id string
    instanceId string
    Observability instance ID to which the alert group is associated.
    interval string
    Specifies the frequency at which rules within the group are evaluated. The interval must be at least 60 seconds and defaults to 60 seconds if not set. Supported formats include hours, minutes, and seconds, either singly or in combination. Examples of valid formats are: '5h30m40s', '5h', '5h30m', '60m', and '60s'.
    name string
    The name of the alert group. Is the identifier and must be unique in the group.
    projectId string
    STACKIT project ID to which the alert group is associated.
    rules GetObservabilityAlertgroupRule[]
    id str
    instance_id str
    Observability instance ID to which the alert group is associated.
    interval str
    Specifies the frequency at which rules within the group are evaluated. The interval must be at least 60 seconds and defaults to 60 seconds if not set. Supported formats include hours, minutes, and seconds, either singly or in combination. Examples of valid formats are: '5h30m40s', '5h', '5h30m', '60m', and '60s'.
    name str
    The name of the alert group. Is the identifier and must be unique in the group.
    project_id str
    STACKIT project ID to which the alert group is associated.
    rules Sequence[GetObservabilityAlertgroupRule]
    id String
    instanceId String
    Observability instance ID to which the alert group is associated.
    interval String
    Specifies the frequency at which rules within the group are evaluated. The interval must be at least 60 seconds and defaults to 60 seconds if not set. Supported formats include hours, minutes, and seconds, either singly or in combination. Examples of valid formats are: '5h30m40s', '5h', '5h30m', '60m', and '60s'.
    name String
    The name of the alert group. Is the identifier and must be unique in the group.
    projectId String
    STACKIT project ID to which the alert group is associated.
    rules List<Property Map>

    Supporting Types

    GetObservabilityAlertgroupRule

    Alert string
    The name of the alert rule. Is the identifier and must be unique in the group.
    Annotations Dictionary<string, string>
    A map of key:value. Annotations to add or overwrite for each alert
    Expression string
    The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.
    For string
    Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. Default is 0s
    Labels Dictionary<string, string>
    A map of key:value. Labels to add or overwrite for each alert
    Record string
    The name of the metric. It's the identifier and must be unique in the group.
    Alert string
    The name of the alert rule. Is the identifier and must be unique in the group.
    Annotations map[string]string
    A map of key:value. Annotations to add or overwrite for each alert
    Expression string
    The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.
    For string
    Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. Default is 0s
    Labels map[string]string
    A map of key:value. Labels to add or overwrite for each alert
    Record string
    The name of the metric. It's the identifier and must be unique in the group.
    alert String
    The name of the alert rule. Is the identifier and must be unique in the group.
    annotations Map<String,String>
    A map of key:value. Annotations to add or overwrite for each alert
    expression String
    The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.
    for_ String
    Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. Default is 0s
    labels Map<String,String>
    A map of key:value. Labels to add or overwrite for each alert
    record String
    The name of the metric. It's the identifier and must be unique in the group.
    alert string
    The name of the alert rule. Is the identifier and must be unique in the group.
    annotations {[key: string]: string}
    A map of key:value. Annotations to add or overwrite for each alert
    expression string
    The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.
    for string
    Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. Default is 0s
    labels {[key: string]: string}
    A map of key:value. Labels to add or overwrite for each alert
    record string
    The name of the metric. It's the identifier and must be unique in the group.
    alert str
    The name of the alert rule. Is the identifier and must be unique in the group.
    annotations Mapping[str, str]
    A map of key:value. Annotations to add or overwrite for each alert
    expression str
    The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.
    for_ str
    Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. Default is 0s
    labels Mapping[str, str]
    A map of key:value. Labels to add or overwrite for each alert
    record str
    The name of the metric. It's the identifier and must be unique in the group.
    alert String
    The name of the alert rule. Is the identifier and must be unique in the group.
    annotations Map<String>
    A map of key:value. Annotations to add or overwrite for each alert
    expression String
    The PromQL expression to evaluate. Every evaluation cycle this is evaluated at the current time, and all resultant time series become pending/firing alerts.
    for String
    Alerts are considered firing once they have been returned for this long. Alerts which have not yet fired for long enough are considered pending. Default is 0s
    labels Map<String>
    A map of key:value. Labels to add or overwrite for each alert
    record String
    The name of the metric. It's the identifier and must be unique in the group.

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.4
    published on Friday, Feb 20, 2026 by stackitcloud
    Schema (JSON)
    stackitcloud/pulumi-stackit
      Try Pulumi Cloud free. Your team will thank you.