stackit.getObservabilityInstance

stackit v0.0.4, Feb 20 26

Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud

Schema (JSON)

stackitcloud/pulumi-stackit

Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud

Schema (JSON)

stackitcloud/pulumi-stackit

Example Usage

data "stackit_observability_instance" "example" {
  project_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  instance_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Using getObservabilityInstance

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 getObservabilityInstance(args: GetObservabilityInstanceArgs, opts?: InvokeOptions): Promise<GetObservabilityInstanceResult>
function getObservabilityInstanceOutput(args: GetObservabilityInstanceOutputArgs, opts?: InvokeOptions): Output<GetObservabilityInstanceResult>

def get_observability_instance(instance_id: Optional[str] = None,
                               project_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetObservabilityInstanceResult
def get_observability_instance_output(instance_id: Optional[pulumi.Input[str]] = None,
                               project_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetObservabilityInstanceResult]

func LookupObservabilityInstance(ctx *Context, args *LookupObservabilityInstanceArgs, opts ...InvokeOption) (*LookupObservabilityInstanceResult, error)
func LookupObservabilityInstanceOutput(ctx *Context, args *LookupObservabilityInstanceOutputArgs, opts ...InvokeOption) LookupObservabilityInstanceResultOutput

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

public static class GetObservabilityInstance 
{
    public static Task<GetObservabilityInstanceResult> InvokeAsync(GetObservabilityInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetObservabilityInstanceResult> Invoke(GetObservabilityInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetObservabilityInstanceResult> getObservabilityInstance(GetObservabilityInstanceArgs args, InvokeOptions options)
public static Output<GetObservabilityInstanceResult> getObservabilityInstance(GetObservabilityInstanceArgs args, InvokeOptions options)

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

The following arguments are supported:

InstanceId string: The Observability instance ID.
ProjectId string: STACKIT project ID to which the instance is associated.

InstanceId string: The Observability instance ID.
ProjectId string: STACKIT project ID to which the instance is associated.

instanceId String: The Observability instance ID.
projectId String: STACKIT project ID to which the instance is associated.

instanceId string: The Observability instance ID.
projectId string: STACKIT project ID to which the instance is associated.

instance_id str: The Observability instance ID.
project_id str: STACKIT project ID to which the instance is associated.

instanceId String: The Observability instance ID.
projectId String: STACKIT project ID to which the instance is associated.

getObservabilityInstance Result

The following output properties are available:

Acls List<string>: The access control list for this instance. Each entry is an IP address range that is permitted to access, in CIDR notation.
AlertConfig GetObservabilityInstanceAlertConfig: Alert configuration for the instance.
AlertingUrl string: Specifies Alerting URL.
DashboardUrl string: Specifies Observability instance dashboard URL.
GrafanaAdminEnabled bool: If true, a default Grafana server admin user was created.
GrafanaInitialAdminPassword string: Specifies an initial Grafana admin password.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
GrafanaInitialAdminUser string: Specifies an initial Grafana admin username.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
GrafanaPublicReadAccess bool: If true, anyone can access Grafana dashboards without logging in.
GrafanaUrl string: Specifies Grafana URL.
Id string
InstanceId string: The Observability instance ID.
IsUpdatable bool: Specifies if the instance can be updated.
JaegerTracesUrl string
JaegerUiUrl string
LogsPushUrl string: Specifies URL for pushing logs.
LogsRetentionDays int: Specifies for how many days the logs are kept. Default is set to 7.
LogsUrl string: Specifies Logs URL.
MetricsPushUrl string: Specifies URL for pushing metrics.
MetricsRetentionDays int: Specifies for how many days the raw metrics are kept. Default is set to 90.
MetricsRetentionDays1hDownsampling int: Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to 90.
MetricsRetentionDays5mDownsampling int: Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to 90.
MetricsUrl string: Specifies metrics URL.
Name string: The name of the Observability instance.
OtlpTracesUrl string
Parameters Dictionary<string, string>: Additional parameters.
PlanId string: The Observability plan ID.
PlanName string: Specifies the Observability plan. E.g. Observability-Monitoring-Medium-EU01.
ProjectId string: STACKIT project ID to which the instance is associated.
TargetsUrl string: Specifies Targets URL.
TracesRetentionDays int: Specifies for how many days the traces are kept. Default is set to 7.
ZipkinSpansUrl string

Acls []string: The access control list for this instance. Each entry is an IP address range that is permitted to access, in CIDR notation.
AlertConfig GetObservabilityInstanceAlertConfig: Alert configuration for the instance.
AlertingUrl string: Specifies Alerting URL.
DashboardUrl string: Specifies Observability instance dashboard URL.
GrafanaAdminEnabled bool: If true, a default Grafana server admin user was created.
GrafanaInitialAdminPassword string: Specifies an initial Grafana admin password.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
GrafanaInitialAdminUser string: Specifies an initial Grafana admin username.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
GrafanaPublicReadAccess bool: If true, anyone can access Grafana dashboards without logging in.
GrafanaUrl string: Specifies Grafana URL.
Id string
InstanceId string: The Observability instance ID.
IsUpdatable bool: Specifies if the instance can be updated.
JaegerTracesUrl string
JaegerUiUrl string
LogsPushUrl string: Specifies URL for pushing logs.
LogsRetentionDays int: Specifies for how many days the logs are kept. Default is set to 7.
LogsUrl string: Specifies Logs URL.
MetricsPushUrl string: Specifies URL for pushing metrics.
MetricsRetentionDays int: Specifies for how many days the raw metrics are kept. Default is set to 90.
MetricsRetentionDays1hDownsampling int: Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to 90.
MetricsRetentionDays5mDownsampling int: Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to 90.
MetricsUrl string: Specifies metrics URL.
Name string: The name of the Observability instance.
OtlpTracesUrl string
Parameters map[string]string: Additional parameters.
PlanId string: The Observability plan ID.
PlanName string: Specifies the Observability plan. E.g. Observability-Monitoring-Medium-EU01.
ProjectId string: STACKIT project ID to which the instance is associated.
TargetsUrl string: Specifies Targets URL.
TracesRetentionDays int: Specifies for how many days the traces are kept. Default is set to 7.
ZipkinSpansUrl string

acls List<String>: The access control list for this instance. Each entry is an IP address range that is permitted to access, in CIDR notation.
alertConfig GetObservabilityInstanceAlertConfig: Alert configuration for the instance.
alertingUrl String: Specifies Alerting URL.
dashboardUrl String: Specifies Observability instance dashboard URL.
grafanaAdminEnabled Boolean: If true, a default Grafana server admin user was created.
grafanaInitialAdminPassword String: Specifies an initial Grafana admin password.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
grafanaInitialAdminUser String: Specifies an initial Grafana admin username.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
grafanaPublicReadAccess Boolean: If true, anyone can access Grafana dashboards without logging in.
grafanaUrl String: Specifies Grafana URL.
id String
instanceId String: The Observability instance ID.
isUpdatable Boolean: Specifies if the instance can be updated.
jaegerTracesUrl String
jaegerUiUrl String
logsPushUrl String: Specifies URL for pushing logs.
logsRetentionDays Integer: Specifies for how many days the logs are kept. Default is set to 7.
logsUrl String: Specifies Logs URL.
metricsPushUrl String: Specifies URL for pushing metrics.
metricsRetentionDays Integer: Specifies for how many days the raw metrics are kept. Default is set to 90.
metricsRetentionDays1hDownsampling Integer: Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to 90.
metricsRetentionDays5mDownsampling Integer: Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to 90.
metricsUrl String: Specifies metrics URL.
name String: The name of the Observability instance.
otlpTracesUrl String
parameters Map<String,String>: Additional parameters.
planId String: The Observability plan ID.
planName String: Specifies the Observability plan. E.g. Observability-Monitoring-Medium-EU01.
projectId String: STACKIT project ID to which the instance is associated.
targetsUrl String: Specifies Targets URL.
tracesRetentionDays Integer: Specifies for how many days the traces are kept. Default is set to 7.
zipkinSpansUrl String

acls string[]: The access control list for this instance. Each entry is an IP address range that is permitted to access, in CIDR notation.
alertConfig GetObservabilityInstanceAlertConfig: Alert configuration for the instance.
alertingUrl string: Specifies Alerting URL.
dashboardUrl string: Specifies Observability instance dashboard URL.
grafanaAdminEnabled boolean: If true, a default Grafana server admin user was created.
grafanaInitialAdminPassword string: Specifies an initial Grafana admin password.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
grafanaInitialAdminUser string: Specifies an initial Grafana admin username.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
grafanaPublicReadAccess boolean: If true, anyone can access Grafana dashboards without logging in.
grafanaUrl string: Specifies Grafana URL.
id string
instanceId string: The Observability instance ID.
isUpdatable boolean: Specifies if the instance can be updated.
jaegerTracesUrl string
jaegerUiUrl string
logsPushUrl string: Specifies URL for pushing logs.
logsRetentionDays number: Specifies for how many days the logs are kept. Default is set to 7.
logsUrl string: Specifies Logs URL.
metricsPushUrl string: Specifies URL for pushing metrics.
metricsRetentionDays number: Specifies for how many days the raw metrics are kept. Default is set to 90.
metricsRetentionDays1hDownsampling number: Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to 90.
metricsRetentionDays5mDownsampling number: Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to 90.
metricsUrl string: Specifies metrics URL.
name string: The name of the Observability instance.
otlpTracesUrl string
parameters {[key: string]: string}: Additional parameters.
planId string: The Observability plan ID.
planName string: Specifies the Observability plan. E.g. Observability-Monitoring-Medium-EU01.
projectId string: STACKIT project ID to which the instance is associated.
targetsUrl string: Specifies Targets URL.
tracesRetentionDays number: Specifies for how many days the traces are kept. Default is set to 7.
zipkinSpansUrl string

acls Sequence[str]: The access control list for this instance. Each entry is an IP address range that is permitted to access, in CIDR notation.
alert_config GetObservabilityInstanceAlertConfig: Alert configuration for the instance.
alerting_url str: Specifies Alerting URL.
dashboard_url str: Specifies Observability instance dashboard URL.
grafana_admin_enabled bool: If true, a default Grafana server admin user was created.
grafana_initial_admin_password str: Specifies an initial Grafana admin password.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
grafana_initial_admin_user str: Specifies an initial Grafana admin username.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
grafana_public_read_access bool: If true, anyone can access Grafana dashboards without logging in.
grafana_url str: Specifies Grafana URL.
id str
instance_id str: The Observability instance ID.
is_updatable bool: Specifies if the instance can be updated.
jaeger_traces_url str
jaeger_ui_url str
logs_push_url str: Specifies URL for pushing logs.
logs_retention_days int: Specifies for how many days the logs are kept. Default is set to 7.
logs_url str: Specifies Logs URL.
metrics_push_url str: Specifies URL for pushing metrics.
metrics_retention_days int: Specifies for how many days the raw metrics are kept. Default is set to 90.
metrics_retention_days1h_downsampling int: Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to 90.
metrics_retention_days5m_downsampling int: Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to 90.
metrics_url str: Specifies metrics URL.
name str: The name of the Observability instance.
otlp_traces_url str
parameters Mapping[str, str]: Additional parameters.
plan_id str: The Observability plan ID.
plan_name str: Specifies the Observability plan. E.g. Observability-Monitoring-Medium-EU01.
project_id str: STACKIT project ID to which the instance is associated.
targets_url str: Specifies Targets URL.
traces_retention_days int: Specifies for how many days the traces are kept. Default is set to 7.
zipkin_spans_url str

acls List<String>: The access control list for this instance. Each entry is an IP address range that is permitted to access, in CIDR notation.
alertConfig Property Map: Alert configuration for the instance.
alertingUrl String: Specifies Alerting URL.
dashboardUrl String: Specifies Observability instance dashboard URL.
grafanaAdminEnabled Boolean: If true, a default Grafana server admin user was created.
grafanaInitialAdminPassword String: Specifies an initial Grafana admin password.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
grafanaInitialAdminUser String: Specifies an initial Grafana admin username.
Deprecated: This attribute is deprecated and will be removed on July 5, 2026. Use grafana_admin_enabled instead.
grafanaPublicReadAccess Boolean: If true, anyone can access Grafana dashboards without logging in.
grafanaUrl String: Specifies Grafana URL.
id String
instanceId String: The Observability instance ID.
isUpdatable Boolean: Specifies if the instance can be updated.
jaegerTracesUrl String
jaegerUiUrl String
logsPushUrl String: Specifies URL for pushing logs.
logsRetentionDays Number: Specifies for how many days the logs are kept. Default is set to 7.
logsUrl String: Specifies Logs URL.
metricsPushUrl String: Specifies URL for pushing metrics.
metricsRetentionDays Number: Specifies for how many days the raw metrics are kept. Default is set to 90.
metricsRetentionDays1hDownsampling Number: Specifies for how many days the 1h downsampled metrics are kept. must be less than the value of the 5m downsampling retention. Default is set to 90.
metricsRetentionDays5mDownsampling Number: Specifies for how many days the 5m downsampled metrics are kept. must be less than the value of the general retention. Default is set to 90.
metricsUrl String: Specifies metrics URL.
name String: The name of the Observability instance.
otlpTracesUrl String
parameters Map<String>: Additional parameters.
planId String: The Observability plan ID.
planName String: Specifies the Observability plan. E.g. Observability-Monitoring-Medium-EU01.
projectId String: STACKIT project ID to which the instance is associated.
targetsUrl String: Specifies Targets URL.
tracesRetentionDays Number: Specifies for how many days the traces are kept. Default is set to 7.
zipkinSpansUrl String

Supporting Types

GetObservabilityInstanceAlertConfig

Global GetObservabilityInstanceAlertConfigGlobal: Global configuration for the alerts.
Receivers List<GetObservabilityInstanceAlertConfigReceiver>: List of alert receivers.
Route GetObservabilityInstanceAlertConfigRoute: The route for the alert.

Global GetObservabilityInstanceAlertConfigGlobal: Global configuration for the alerts.
Receivers []GetObservabilityInstanceAlertConfigReceiver: List of alert receivers.
Route GetObservabilityInstanceAlertConfigRoute: The route for the alert.

global GetObservabilityInstanceAlertConfigGlobal: Global configuration for the alerts.
receivers List<GetObservabilityInstanceAlertConfigReceiver>: List of alert receivers.
route GetObservabilityInstanceAlertConfigRoute: The route for the alert.

global GetObservabilityInstanceAlertConfigGlobal: Global configuration for the alerts.
receivers GetObservabilityInstanceAlertConfigReceiver[]: List of alert receivers.
route GetObservabilityInstanceAlertConfigRoute: The route for the alert.

global_ GetObservabilityInstanceAlertConfigGlobal: Global configuration for the alerts.
receivers Sequence[GetObservabilityInstanceAlertConfigReceiver]: List of alert receivers.
route GetObservabilityInstanceAlertConfigRoute: The route for the alert.

global Property Map: Global configuration for the alerts.
receivers List<Property Map>: List of alert receivers.
route Property Map: The route for the alert.

GetObservabilityInstanceAlertConfigGlobal

OpsgenieApiKey string: The API key for OpsGenie.
OpsgenieApiUrl string: The host to send OpsGenie API requests to. Must be a valid URL
ResolveTimeout string: The default value used by alertmanager if the alert does not include EndsAt. After this time passes, it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt.
SmtpAuthIdentity string: SMTP authentication information. Must be a valid email address
SmtpAuthPassword string: SMTP Auth using LOGIN and PLAIN.
SmtpAuthUsername string: SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.
SmtpFrom string: The default SMTP From header field. Must be a valid email address
SmtpSmartHost string: The default SMTP smarthost used for sending emails, including port number. Port number usually is 25, or 587 for SMTP over TLS (sometimes referred to as STARTTLS).

OpsgenieApiKey string: The API key for OpsGenie.
OpsgenieApiUrl string: The host to send OpsGenie API requests to. Must be a valid URL
ResolveTimeout string: The default value used by alertmanager if the alert does not include EndsAt. After this time passes, it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt.
SmtpAuthIdentity string: SMTP authentication information. Must be a valid email address
SmtpAuthPassword string: SMTP Auth using LOGIN and PLAIN.
SmtpAuthUsername string: SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.
SmtpFrom string: The default SMTP From header field. Must be a valid email address
SmtpSmartHost string: The default SMTP smarthost used for sending emails, including port number. Port number usually is 25, or 587 for SMTP over TLS (sometimes referred to as STARTTLS).

opsgenieApiKey String: The API key for OpsGenie.
opsgenieApiUrl String: The host to send OpsGenie API requests to. Must be a valid URL
resolveTimeout String: The default value used by alertmanager if the alert does not include EndsAt. After this time passes, it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt.
smtpAuthIdentity String: SMTP authentication information. Must be a valid email address
smtpAuthPassword String: SMTP Auth using LOGIN and PLAIN.
smtpAuthUsername String: SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.
smtpFrom String: The default SMTP From header field. Must be a valid email address
smtpSmartHost String: The default SMTP smarthost used for sending emails, including port number. Port number usually is 25, or 587 for SMTP over TLS (sometimes referred to as STARTTLS).

opsgenieApiKey string: The API key for OpsGenie.
opsgenieApiUrl string: The host to send OpsGenie API requests to. Must be a valid URL
resolveTimeout string: The default value used by alertmanager if the alert does not include EndsAt. After this time passes, it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt.
smtpAuthIdentity string: SMTP authentication information. Must be a valid email address
smtpAuthPassword string: SMTP Auth using LOGIN and PLAIN.
smtpAuthUsername string: SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.
smtpFrom string: The default SMTP From header field. Must be a valid email address
smtpSmartHost string: The default SMTP smarthost used for sending emails, including port number. Port number usually is 25, or 587 for SMTP over TLS (sometimes referred to as STARTTLS).

opsgenie_api_key str: The API key for OpsGenie.
opsgenie_api_url str: The host to send OpsGenie API requests to. Must be a valid URL
resolve_timeout str: The default value used by alertmanager if the alert does not include EndsAt. After this time passes, it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt.
smtp_auth_identity str: SMTP authentication information. Must be a valid email address
smtp_auth_password str: SMTP Auth using LOGIN and PLAIN.
smtp_auth_username str: SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.
smtp_from str: The default SMTP From header field. Must be a valid email address
smtp_smart_host str: The default SMTP smarthost used for sending emails, including port number. Port number usually is 25, or 587 for SMTP over TLS (sometimes referred to as STARTTLS).

opsgenieApiKey String: The API key for OpsGenie.
opsgenieApiUrl String: The host to send OpsGenie API requests to. Must be a valid URL
resolveTimeout String: The default value used by alertmanager if the alert does not include EndsAt. After this time passes, it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt.
smtpAuthIdentity String: SMTP authentication information. Must be a valid email address
smtpAuthPassword String: SMTP Auth using LOGIN and PLAIN.
smtpAuthUsername String: SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.
smtpFrom String: The default SMTP From header field. Must be a valid email address
smtpSmartHost String: The default SMTP smarthost used for sending emails, including port number. Port number usually is 25, or 587 for SMTP over TLS (sometimes referred to as STARTTLS).

GetObservabilityInstanceAlertConfigReceiver

EmailConfigs List<GetObservabilityInstanceAlertConfigReceiverEmailConfig>: List of email configurations.
Name string: Name of the receiver.
OpsgenieConfigs List<GetObservabilityInstanceAlertConfigReceiverOpsgenieConfig>: List of OpsGenie configurations.
WebhooksConfigs List<GetObservabilityInstanceAlertConfigReceiverWebhooksConfig>: List of Webhooks configurations.

EmailConfigs []GetObservabilityInstanceAlertConfigReceiverEmailConfig: List of email configurations.
Name string: Name of the receiver.
OpsgenieConfigs []GetObservabilityInstanceAlertConfigReceiverOpsgenieConfig: List of OpsGenie configurations.
WebhooksConfigs []GetObservabilityInstanceAlertConfigReceiverWebhooksConfig: List of Webhooks configurations.

emailConfigs List<GetObservabilityInstanceAlertConfigReceiverEmailConfig>: List of email configurations.
name String: Name of the receiver.
opsgenieConfigs List<GetObservabilityInstanceAlertConfigReceiverOpsgenieConfig>: List of OpsGenie configurations.
webhooksConfigs List<GetObservabilityInstanceAlertConfigReceiverWebhooksConfig>: List of Webhooks configurations.

emailConfigs GetObservabilityInstanceAlertConfigReceiverEmailConfig[]: List of email configurations.
name string: Name of the receiver.
opsgenieConfigs GetObservabilityInstanceAlertConfigReceiverOpsgenieConfig[]: List of OpsGenie configurations.
webhooksConfigs GetObservabilityInstanceAlertConfigReceiverWebhooksConfig[]: List of Webhooks configurations.

email_configs Sequence[GetObservabilityInstanceAlertConfigReceiverEmailConfig]: List of email configurations.
name str: Name of the receiver.
opsgenie_configs Sequence[GetObservabilityInstanceAlertConfigReceiverOpsgenieConfig]: List of OpsGenie configurations.
webhooks_configs Sequence[GetObservabilityInstanceAlertConfigReceiverWebhooksConfig]: List of Webhooks configurations.

emailConfigs List<Property Map>: List of email configurations.
name String: Name of the receiver.
opsgenieConfigs List<Property Map>: List of OpsGenie configurations.
webhooksConfigs List<Property Map>: List of Webhooks configurations.

GetObservabilityInstanceAlertConfigReceiverEmailConfig

AuthIdentity string: SMTP authentication information. Must be a valid email address
AuthPassword string: SMTP authentication password.
AuthUsername string: SMTP authentication username.
From string: The sender email address. Must be a valid email address
SendResolved bool: Whether to notify about resolved alerts.
SmartHost string: The SMTP host through which emails are sent.
To string: The email address to send notifications to. Must be a valid email address

AuthIdentity string: SMTP authentication information. Must be a valid email address
AuthPassword string: SMTP authentication password.
AuthUsername string: SMTP authentication username.
From string: The sender email address. Must be a valid email address
SendResolved bool: Whether to notify about resolved alerts.
SmartHost string: The SMTP host through which emails are sent.
To string: The email address to send notifications to. Must be a valid email address

authIdentity String: SMTP authentication information. Must be a valid email address
authPassword String: SMTP authentication password.
authUsername String: SMTP authentication username.
from String: The sender email address. Must be a valid email address
sendResolved Boolean: Whether to notify about resolved alerts.
smartHost String: The SMTP host through which emails are sent.
to String: The email address to send notifications to. Must be a valid email address

authIdentity string: SMTP authentication information. Must be a valid email address
authPassword string: SMTP authentication password.
authUsername string: SMTP authentication username.
from string: The sender email address. Must be a valid email address
sendResolved boolean: Whether to notify about resolved alerts.
smartHost string: The SMTP host through which emails are sent.
to string: The email address to send notifications to. Must be a valid email address

auth_identity str: SMTP authentication information. Must be a valid email address
auth_password str: SMTP authentication password.
auth_username str: SMTP authentication username.
from_ str: The sender email address. Must be a valid email address
send_resolved bool: Whether to notify about resolved alerts.
smart_host str: The SMTP host through which emails are sent.
to str: The email address to send notifications to. Must be a valid email address

authIdentity String: SMTP authentication information. Must be a valid email address
authPassword String: SMTP authentication password.
authUsername String: SMTP authentication username.
from String: The sender email address. Must be a valid email address
sendResolved Boolean: Whether to notify about resolved alerts.
smartHost String: The SMTP host through which emails are sent.
to String: The email address to send notifications to. Must be a valid email address

GetObservabilityInstanceAlertConfigReceiverOpsgenieConfig

ApiKey string: The API key for OpsGenie.
ApiUrl string: The host to send OpsGenie API requests to. Must be a valid URL
Priority string: Priority of the alert. Possible values are: P1, P2, P3, P4, P5.
SendResolved bool: Whether to notify about resolved alerts.
Tags string: Comma separated list of tags attached to the notifications.

ApiKey string: The API key for OpsGenie.
ApiUrl string: The host to send OpsGenie API requests to. Must be a valid URL
Priority string: Priority of the alert. Possible values are: P1, P2, P3, P4, P5.
SendResolved bool: Whether to notify about resolved alerts.
Tags string: Comma separated list of tags attached to the notifications.

apiKey String: The API key for OpsGenie.
apiUrl String: The host to send OpsGenie API requests to. Must be a valid URL
priority String: Priority of the alert. Possible values are: P1, P2, P3, P4, P5.
sendResolved Boolean: Whether to notify about resolved alerts.
tags String: Comma separated list of tags attached to the notifications.

apiKey string: The API key for OpsGenie.
apiUrl string: The host to send OpsGenie API requests to. Must be a valid URL
priority string: Priority of the alert. Possible values are: P1, P2, P3, P4, P5.
sendResolved boolean: Whether to notify about resolved alerts.
tags string: Comma separated list of tags attached to the notifications.

api_key str: The API key for OpsGenie.
api_url str: The host to send OpsGenie API requests to. Must be a valid URL
priority str: Priority of the alert. Possible values are: P1, P2, P3, P4, P5.
send_resolved bool: Whether to notify about resolved alerts.
tags str: Comma separated list of tags attached to the notifications.

apiKey String: The API key for OpsGenie.
apiUrl String: The host to send OpsGenie API requests to. Must be a valid URL
priority String: Priority of the alert. Possible values are: P1, P2, P3, P4, P5.
sendResolved Boolean: Whether to notify about resolved alerts.
tags String: Comma separated list of tags attached to the notifications.

GetObservabilityInstanceAlertConfigReceiverWebhooksConfig

GoogleChat bool: Google Chat webhooks require special handling, set this to true if the webhook is for Google Chat.
MsTeams bool: Microsoft Teams webhooks require special handling, set this to true if the webhook is for Microsoft Teams.
SendResolved bool: Whether to notify about resolved alerts.
Url string: The endpoint to send HTTP POST requests to. Must be a valid URL

GoogleChat bool: Google Chat webhooks require special handling, set this to true if the webhook is for Google Chat.
MsTeams bool: Microsoft Teams webhooks require special handling, set this to true if the webhook is for Microsoft Teams.
SendResolved bool: Whether to notify about resolved alerts.
Url string: The endpoint to send HTTP POST requests to. Must be a valid URL

googleChat Boolean: Google Chat webhooks require special handling, set this to true if the webhook is for Google Chat.
msTeams Boolean: Microsoft Teams webhooks require special handling, set this to true if the webhook is for Microsoft Teams.
sendResolved Boolean: Whether to notify about resolved alerts.
url String: The endpoint to send HTTP POST requests to. Must be a valid URL

googleChat boolean: Google Chat webhooks require special handling, set this to true if the webhook is for Google Chat.
msTeams boolean: Microsoft Teams webhooks require special handling, set this to true if the webhook is for Microsoft Teams.
sendResolved boolean: Whether to notify about resolved alerts.
url string: The endpoint to send HTTP POST requests to. Must be a valid URL

google_chat bool: Google Chat webhooks require special handling, set this to true if the webhook is for Google Chat.
ms_teams bool: Microsoft Teams webhooks require special handling, set this to true if the webhook is for Microsoft Teams.
send_resolved bool: Whether to notify about resolved alerts.
url str: The endpoint to send HTTP POST requests to. Must be a valid URL

googleChat Boolean: Google Chat webhooks require special handling, set this to true if the webhook is for Google Chat.
msTeams Boolean: Microsoft Teams webhooks require special handling, set this to true if the webhook is for Microsoft Teams.
sendResolved Boolean: Whether to notify about resolved alerts.
url String: The endpoint to send HTTP POST requests to. Must be a valid URL

GetObservabilityInstanceAlertConfigRoute

Continue bool: Whether an alert should continue matching subsequent sibling nodes.
GroupBies List<string>: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
GroupInterval string: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
GroupWait string: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) .
Receiver string: The name of the receiver to route the alerts to.
RepeatInterval string: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).
Routes List<GetObservabilityInstanceAlertConfigRouteRoute>: List of child routes.

Continue bool: Whether an alert should continue matching subsequent sibling nodes.
GroupBies []string: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
GroupInterval string: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
GroupWait string: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) .
Receiver string: The name of the receiver to route the alerts to.
RepeatInterval string: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).
Routes []GetObservabilityInstanceAlertConfigRouteRoute: List of child routes.

continue_ Boolean: Whether an alert should continue matching subsequent sibling nodes.
groupBies List<String>: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
groupInterval String: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
groupWait String: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) .
receiver String: The name of the receiver to route the alerts to.
repeatInterval String: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).
routes List<GetObservabilityInstanceAlertConfigRouteRoute>: List of child routes.

continue boolean: Whether an alert should continue matching subsequent sibling nodes.
groupBies string[]: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
groupInterval string: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
groupWait string: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) .
receiver string: The name of the receiver to route the alerts to.
repeatInterval string: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).
routes GetObservabilityInstanceAlertConfigRouteRoute[]: List of child routes.

continue_ bool: Whether an alert should continue matching subsequent sibling nodes.
group_bies Sequence[str]: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
group_interval str: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
group_wait str: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) .
receiver str: The name of the receiver to route the alerts to.
repeat_interval str: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).
routes Sequence[GetObservabilityInstanceAlertConfigRouteRoute]: List of child routes.

continue Boolean: Whether an alert should continue matching subsequent sibling nodes.
groupBies List<String>: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
groupInterval String: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
groupWait String: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.) .
receiver String: The name of the receiver to route the alerts to.
repeatInterval String: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).
routes List<Property Map>: List of child routes.

GetObservabilityInstanceAlertConfigRouteRoute

Continue bool: Whether an alert should continue matching subsequent sibling nodes.
GroupBies List<string>: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
GroupInterval string: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
GroupWait string: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.)
Match Dictionary<string, string>: A set of equality matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
MatchRegex Dictionary<string, string>: A set of regex-matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
Matchers List<string>: A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics.
Receiver string: The name of the receiver to route the alerts to.
RepeatInterval string: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).

Continue bool: Whether an alert should continue matching subsequent sibling nodes.
GroupBies []string: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
GroupInterval string: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
GroupWait string: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.)
Match map[string]string: A set of equality matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
MatchRegex map[string]string: A set of regex-matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
Matchers []string: A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics.
Receiver string: The name of the receiver to route the alerts to.
RepeatInterval string: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).

continue_ Boolean: Whether an alert should continue matching subsequent sibling nodes.
groupBies List<String>: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
groupInterval String: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
groupWait String: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.)
match Map<String,String>: A set of equality matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
matchRegex Map<String,String>: A set of regex-matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
matchers List<String>: A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics.
receiver String: The name of the receiver to route the alerts to.
repeatInterval String: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).

continue boolean: Whether an alert should continue matching subsequent sibling nodes.
groupBies string[]: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
groupInterval string: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
groupWait string: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.)
match {[key: string]: string}: A set of equality matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
matchRegex {[key: string]: string}: A set of regex-matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
matchers string[]: A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics.
receiver string: The name of the receiver to route the alerts to.
repeatInterval string: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).

continue_ bool: Whether an alert should continue matching subsequent sibling nodes.
group_bies Sequence[str]: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
group_interval str: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
group_wait str: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.)
match Mapping[str, str]: A set of equality matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
match_regex Mapping[str, str]: A set of regex-matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
matchers Sequence[str]: A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics.
receiver str: The name of the receiver to route the alerts to.
repeat_interval str: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).

continue Boolean: Whether an alert should continue matching subsequent sibling nodes.
groupBies List<String>: The labels by which incoming alerts are grouped together. For example, multiple alerts coming in for cluster=A and alertname=LatencyHigh would be batched into a single group. To aggregate by all possible labels use the special value '...' as the sole label name, for example: group_by: ['...']. This effectively disables aggregation entirely, passing through all alerts as-is. This is unlikely to be what you want, unless you have a very low alert volume or your upstream notification system performs its own grouping.
groupInterval String: How long to wait before sending a notification about new alerts that are added to a group of alerts for which an initial notification has already been sent. (Usually ~5m or more.)
groupWait String: How long to initially wait to send a notification for a group of alerts. Allows to wait for an inhibiting alert to arrive or collect more initial alerts for the same group. (Usually ~0s to few minutes.)
match Map<String>: A set of equality matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
matchRegex Map<String>: A set of regex-matchers an alert has to fulfill to match the node. This field is deprecated and will be removed after 10th March 2026, use matchers in the routes instead
Deprecated: Use matchers in the routes instead.
matchers List<String>: A list of matchers that an alert has to fulfill to match the node. A matcher is a string with a syntax inspired by PromQL and OpenMetrics.
receiver String: The name of the receiver to route the alerts to.
repeatInterval String: How long to wait before sending a notification again if it has already been sent successfully for an alert. (Usually ~3h or more).

Package Details

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

Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud

Schema (JSON)

stackitcloud/pulumi-stackit

stackit.getObservabilityInstance

On this page

On this page

Example Usage

Using getObservabilityInstance

getObservabilityInstance Result

Supporting Types

GetObservabilityInstanceAlertConfig

GetObservabilityInstanceAlertConfigGlobal

GetObservabilityInstanceAlertConfigReceiver

GetObservabilityInstanceAlertConfigReceiverEmailConfig

GetObservabilityInstanceAlertConfigReceiverOpsgenieConfig

GetObservabilityInstanceAlertConfigReceiverWebhooksConfig

GetObservabilityInstanceAlertConfigRoute

GetObservabilityInstanceAlertConfigRouteRoute

Package Details

On this page

On this page