1. Packages
  2. Dome9 Provider
  3. API Docs
  4. getNotification
dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9

dome9.getNotification

Explore with Pulumi AI

—

layout: “dome9” page_title: “Check Point CloudGuard: dome9.Notification” sidebar_current: “docs-data-source-dome9-notification” description: |- Fetches details of a specific Dome9 notification.

dome9_notification

This data source is used to fetch details of a specific CloudGuard notification. You can retrieve various details about the notification such as its name, description, alert console settings, and integration settings.

Example Usage

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

const example = dome9.getNotification({
    id: "your-notification-id",
});
export const notificationName = example.then(example => example.name);
export const notificationDescription = example.then(example => example.description);
export const alertsConsole = example.then(example => example.alertsConsole);
export const integrationSettings = example.then(example => example.integrationSettings);
Copy
import pulumi
import pulumi_dome9 as dome9

example = dome9.get_notification(id="your-notification-id")
pulumi.export("notificationName", example.name)
pulumi.export("notificationDescription", example.description)
pulumi.export("alertsConsole", example.alerts_console)
pulumi.export("integrationSettings", example.integration_settings)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/dome9/dome9"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := dome9.LookupNotification(ctx, &dome9.LookupNotificationArgs{
			Id: "your-notification-id",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("notificationName", example.Name)
		ctx.Export("notificationDescription", example.Description)
		ctx.Export("alertsConsole", example.AlertsConsole)
		ctx.Export("integrationSettings", example.IntegrationSettings)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Dome9 = Pulumi.Dome9;

return await Deployment.RunAsync(() => 
{
    var example = Dome9.GetNotification.Invoke(new()
    {
        Id = "your-notification-id",
    });

    return new Dictionary<string, object?>
    {
        ["notificationName"] = example.Apply(getNotificationResult => getNotificationResult.Name),
        ["notificationDescription"] = example.Apply(getNotificationResult => getNotificationResult.Description),
        ["alertsConsole"] = example.Apply(getNotificationResult => getNotificationResult.AlertsConsole),
        ["integrationSettings"] = example.Apply(getNotificationResult => getNotificationResult.IntegrationSettings),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dome9.Dome9Functions;
import com.pulumi.dome9.inputs.GetNotificationArgs;
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 = Dome9Functions.getNotification(GetNotificationArgs.builder()
            .id("your-notification-id")
            .build());

        ctx.export("notificationName", example.applyValue(getNotificationResult -> getNotificationResult.name()));
        ctx.export("notificationDescription", example.applyValue(getNotificationResult -> getNotificationResult.description()));
        ctx.export("alertsConsole", example.applyValue(getNotificationResult -> getNotificationResult.alertsConsole()));
        ctx.export("integrationSettings", example.applyValue(getNotificationResult -> getNotificationResult.integrationSettings()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: dome9:getNotification
      arguments:
        id: your-notification-id
outputs:
  notificationName: ${example.name}
  notificationDescription: ${example.description}
  alertsConsole: ${example.alertsConsole}
  integrationSettings: ${example.integrationSettings}
Copy

Using getNotification

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 getNotification(args: GetNotificationArgs, opts?: InvokeOptions): Promise<GetNotificationResult>
function getNotificationOutput(args: GetNotificationOutputArgs, opts?: InvokeOptions): Output<GetNotificationResult>
Copy
def get_notification(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNotificationResult
def get_notification_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNotificationResult]
Copy
func LookupNotification(ctx *Context, args *LookupNotificationArgs, opts ...InvokeOption) (*LookupNotificationResult, error)
func LookupNotificationOutput(ctx *Context, args *LookupNotificationOutputArgs, opts ...InvokeOption) LookupNotificationResultOutput
Copy

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

public static class GetNotification 
{
    public static Task<GetNotificationResult> InvokeAsync(GetNotificationArgs args, InvokeOptions? opts = null)
    public static Output<GetNotificationResult> Invoke(GetNotificationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetNotificationResult> getNotification(GetNotificationArgs args, InvokeOptions options)
public static Output<GetNotificationResult> getNotification(GetNotificationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: dome9:index/getNotification:getNotification
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The ID of the Dome9 notification to retrieve information for.
Id This property is required. string
The ID of the Dome9 notification to retrieve information for.
id This property is required. String
The ID of the Dome9 notification to retrieve information for.
id This property is required. string
The ID of the Dome9 notification to retrieve information for.
id This property is required. str
The ID of the Dome9 notification to retrieve information for.
id This property is required. String
The ID of the Dome9 notification to retrieve information for.

getNotification Result

The following output properties are available:

AlertsConsole bool
Indicates if alerts will be sent to the CloudGuard console.
Description string
The description of the CloudGuard notification.
Id string
IntegrationSettings List<GetNotificationIntegrationSetting>
A list of integration settings for the notification. This includes:
Name string
The name of the CloudGuard notification.
Origin string
SendOnEachOccurrence bool
AlertsConsole bool
Indicates if alerts will be sent to the CloudGuard console.
Description string
The description of the CloudGuard notification.
Id string
IntegrationSettings []GetNotificationIntegrationSetting
A list of integration settings for the notification. This includes:
Name string
The name of the CloudGuard notification.
Origin string
SendOnEachOccurrence bool
alertsConsole Boolean
Indicates if alerts will be sent to the CloudGuard console.
description String
The description of the CloudGuard notification.
id String
integrationSettings List<GetNotificationIntegrationSetting>
A list of integration settings for the notification. This includes:
name String
The name of the CloudGuard notification.
origin String
sendOnEachOccurrence Boolean
alertsConsole boolean
Indicates if alerts will be sent to the CloudGuard console.
description string
The description of the CloudGuard notification.
id string
integrationSettings GetNotificationIntegrationSetting[]
A list of integration settings for the notification. This includes:
name string
The name of the CloudGuard notification.
origin string
sendOnEachOccurrence boolean
alerts_console bool
Indicates if alerts will be sent to the CloudGuard console.
description str
The description of the CloudGuard notification.
id str
integration_settings Sequence[GetNotificationIntegrationSetting]
A list of integration settings for the notification. This includes:
name str
The name of the CloudGuard notification.
origin str
send_on_each_occurrence bool
alertsConsole Boolean
Indicates if alerts will be sent to the CloudGuard console.
description String
The description of the CloudGuard notification.
id String
integrationSettings List<Property Map>
A list of integration settings for the notification. This includes:
name String
The name of the CloudGuard notification.
origin String
sendOnEachOccurrence Boolean

Supporting Types

GetNotificationIntegrationSetting

ReportsIntegrationSettings This property is required. List<GetNotificationIntegrationSettingReportsIntegrationSetting>
(Optional) A list of report integration settings blocks. Each block includes:
ScheduledIntegrationSettings This property is required. List<GetNotificationIntegrationSettingScheduledIntegrationSetting>
(Optional) A list of scheduled notification integration settings blocks. Each block includes:
SingleNotificationIntegrationSettings This property is required. List<GetNotificationIntegrationSettingSingleNotificationIntegrationSetting>
(Optional) A list of single notification integration settings blocks. Each block includes:
ReportsIntegrationSettings This property is required. []GetNotificationIntegrationSettingReportsIntegrationSetting
(Optional) A list of report integration settings blocks. Each block includes:
ScheduledIntegrationSettings This property is required. []GetNotificationIntegrationSettingScheduledIntegrationSetting
(Optional) A list of scheduled notification integration settings blocks. Each block includes:
SingleNotificationIntegrationSettings This property is required. []GetNotificationIntegrationSettingSingleNotificationIntegrationSetting
(Optional) A list of single notification integration settings blocks. Each block includes:
reportsIntegrationSettings This property is required. List<GetNotificationIntegrationSettingReportsIntegrationSetting>
(Optional) A list of report integration settings blocks. Each block includes:
scheduledIntegrationSettings This property is required. List<GetNotificationIntegrationSettingScheduledIntegrationSetting>
(Optional) A list of scheduled notification integration settings blocks. Each block includes:
singleNotificationIntegrationSettings This property is required. List<GetNotificationIntegrationSettingSingleNotificationIntegrationSetting>
(Optional) A list of single notification integration settings blocks. Each block includes:
reportsIntegrationSettings This property is required. GetNotificationIntegrationSettingReportsIntegrationSetting[]
(Optional) A list of report integration settings blocks. Each block includes:
scheduledIntegrationSettings This property is required. GetNotificationIntegrationSettingScheduledIntegrationSetting[]
(Optional) A list of scheduled notification integration settings blocks. Each block includes:
singleNotificationIntegrationSettings This property is required. GetNotificationIntegrationSettingSingleNotificationIntegrationSetting[]
(Optional) A list of single notification integration settings blocks. Each block includes:
reports_integration_settings This property is required. Sequence[GetNotificationIntegrationSettingReportsIntegrationSetting]
(Optional) A list of report integration settings blocks. Each block includes:
scheduled_integration_settings This property is required. Sequence[GetNotificationIntegrationSettingScheduledIntegrationSetting]
(Optional) A list of scheduled notification integration settings blocks. Each block includes:
single_notification_integration_settings This property is required. Sequence[GetNotificationIntegrationSettingSingleNotificationIntegrationSetting]
(Optional) A list of single notification integration settings blocks. Each block includes:
reportsIntegrationSettings This property is required. List<Property Map>
(Optional) A list of report integration settings blocks. Each block includes:
scheduledIntegrationSettings This property is required. List<Property Map>
(Optional) A list of scheduled notification integration settings blocks. Each block includes:
singleNotificationIntegrationSettings This property is required. List<Property Map>
(Optional) A list of single notification integration settings blocks. Each block includes:

GetNotificationIntegrationSettingReportsIntegrationSetting

Filters This property is required. List<GetNotificationIntegrationSettingReportsIntegrationSettingFilter>
IntegrationId This property is required. string
(Required) The ID of the integration.
OutputType This property is required. string
(Optional) The output type of the integration.
Filters This property is required. []GetNotificationIntegrationSettingReportsIntegrationSettingFilter
IntegrationId This property is required. string
(Required) The ID of the integration.
OutputType This property is required. string
(Optional) The output type of the integration.
filters This property is required. List<GetNotificationIntegrationSettingReportsIntegrationSettingFilter>
integrationId This property is required. String
(Required) The ID of the integration.
outputType This property is required. String
(Optional) The output type of the integration.
filters This property is required. GetNotificationIntegrationSettingReportsIntegrationSettingFilter[]
integrationId This property is required. string
(Required) The ID of the integration.
outputType This property is required. string
(Optional) The output type of the integration.
filters This property is required. Sequence[GetNotificationIntegrationSettingReportsIntegrationSettingFilter]
integration_id This property is required. str
(Required) The ID of the integration.
output_type This property is required. str
(Optional) The output type of the integration.
filters This property is required. List<Property Map>
integrationId This property is required. String
(Required) The ID of the integration.
outputType This property is required. String
(Optional) The output type of the integration.

GetNotificationIntegrationSettingReportsIntegrationSettingFilter

EntityCategories This property is required. List<string>
EntityIds This property is required. List<string>
EntityNames This property is required. List<string>
EntityTags This property is required. List<GetNotificationIntegrationSettingReportsIntegrationSettingFilterEntityTag>
RuleEntityTypes This property is required. List<string>
Severities This property is required. List<string>
EntityCategories This property is required. []string
EntityIds This property is required. []string
EntityNames This property is required. []string
EntityTags This property is required. []GetNotificationIntegrationSettingReportsIntegrationSettingFilterEntityTag
RuleEntityTypes This property is required. []string
Severities This property is required. []string
entityCategories This property is required. List<String>
entityIds This property is required. List<String>
entityNames This property is required. List<String>
entityTags This property is required. List<GetNotificationIntegrationSettingReportsIntegrationSettingFilterEntityTag>
ruleEntityTypes This property is required. List<String>
severities This property is required. List<String>
entityCategories This property is required. string[]
entityIds This property is required. string[]
entityNames This property is required. string[]
entityTags This property is required. GetNotificationIntegrationSettingReportsIntegrationSettingFilterEntityTag[]
ruleEntityTypes This property is required. string[]
severities This property is required. string[]
entity_categories This property is required. Sequence[str]
entity_ids This property is required. Sequence[str]
entity_names This property is required. Sequence[str]
entity_tags This property is required. Sequence[GetNotificationIntegrationSettingReportsIntegrationSettingFilterEntityTag]
rule_entity_types This property is required. Sequence[str]
severities This property is required. Sequence[str]
entityCategories This property is required. List<String>
entityIds This property is required. List<String>
entityNames This property is required. List<String>
entityTags This property is required. List<Property Map>
ruleEntityTypes This property is required. List<String>
severities This property is required. List<String>

GetNotificationIntegrationSettingReportsIntegrationSettingFilterEntityTag

Key This property is required. string
Value This property is required. string
Key This property is required. string
Value This property is required. string
key This property is required. String
value This property is required. String
key This property is required. string
value This property is required. string
key This property is required. str
value This property is required. str
key This property is required. String
value This property is required. String

GetNotificationIntegrationSettingScheduledIntegrationSetting

CronExpression This property is required. string
(Required) The cron expression for the scheduled notification.
Filters This property is required. List<GetNotificationIntegrationSettingScheduledIntegrationSettingFilter>
IntegrationId This property is required. string
(Required) The ID of the integration.
OutputType This property is required. string
(Optional) The output type of the integration.
CronExpression This property is required. string
(Required) The cron expression for the scheduled notification.
Filters This property is required. []GetNotificationIntegrationSettingScheduledIntegrationSettingFilter
IntegrationId This property is required. string
(Required) The ID of the integration.
OutputType This property is required. string
(Optional) The output type of the integration.
cronExpression This property is required. String
(Required) The cron expression for the scheduled notification.
filters This property is required. List<GetNotificationIntegrationSettingScheduledIntegrationSettingFilter>
integrationId This property is required. String
(Required) The ID of the integration.
outputType This property is required. String
(Optional) The output type of the integration.
cronExpression This property is required. string
(Required) The cron expression for the scheduled notification.
filters This property is required. GetNotificationIntegrationSettingScheduledIntegrationSettingFilter[]
integrationId This property is required. string
(Required) The ID of the integration.
outputType This property is required. string
(Optional) The output type of the integration.
cron_expression This property is required. str
(Required) The cron expression for the scheduled notification.
filters This property is required. Sequence[GetNotificationIntegrationSettingScheduledIntegrationSettingFilter]
integration_id This property is required. str
(Required) The ID of the integration.
output_type This property is required. str
(Optional) The output type of the integration.
cronExpression This property is required. String
(Required) The cron expression for the scheduled notification.
filters This property is required. List<Property Map>
integrationId This property is required. String
(Required) The ID of the integration.
outputType This property is required. String
(Optional) The output type of the integration.

GetNotificationIntegrationSettingScheduledIntegrationSettingFilter

EntityCategories This property is required. List<string>
EntityIds This property is required. List<string>
EntityNames This property is required. List<string>
EntityTags This property is required. List<GetNotificationIntegrationSettingScheduledIntegrationSettingFilterEntityTag>
RuleEntityTypes This property is required. List<string>
Severities This property is required. List<string>
EntityCategories This property is required. []string
EntityIds This property is required. []string
EntityNames This property is required. []string
EntityTags This property is required. []GetNotificationIntegrationSettingScheduledIntegrationSettingFilterEntityTag
RuleEntityTypes This property is required. []string
Severities This property is required. []string
entityCategories This property is required. List<String>
entityIds This property is required. List<String>
entityNames This property is required. List<String>
entityTags This property is required. List<GetNotificationIntegrationSettingScheduledIntegrationSettingFilterEntityTag>
ruleEntityTypes This property is required. List<String>
severities This property is required. List<String>
entityCategories This property is required. string[]
entityIds This property is required. string[]
entityNames This property is required. string[]
entityTags This property is required. GetNotificationIntegrationSettingScheduledIntegrationSettingFilterEntityTag[]
ruleEntityTypes This property is required. string[]
severities This property is required. string[]
entity_categories This property is required. Sequence[str]
entity_ids This property is required. Sequence[str]
entity_names This property is required. Sequence[str]
entity_tags This property is required. Sequence[GetNotificationIntegrationSettingScheduledIntegrationSettingFilterEntityTag]
rule_entity_types This property is required. Sequence[str]
severities This property is required. Sequence[str]
entityCategories This property is required. List<String>
entityIds This property is required. List<String>
entityNames This property is required. List<String>
entityTags This property is required. List<Property Map>
ruleEntityTypes This property is required. List<String>
severities This property is required. List<String>

GetNotificationIntegrationSettingScheduledIntegrationSettingFilterEntityTag

Key This property is required. string
Value This property is required. string
Key This property is required. string
Value This property is required. string
key This property is required. String
value This property is required. String
key This property is required. string
value This property is required. string
key This property is required. str
value This property is required. str
key This property is required. String
value This property is required. String

GetNotificationIntegrationSettingSingleNotificationIntegrationSetting

Filters This property is required. List<GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilter>
IntegrationId This property is required. string
(Required) The ID of the integration.
OutputType This property is required. string
(Optional) The output type of the integration.
Payload This property is required. string
(Optional) The payload of the notification (only for Jira).
Filters This property is required. []GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilter
IntegrationId This property is required. string
(Required) The ID of the integration.
OutputType This property is required. string
(Optional) The output type of the integration.
Payload This property is required. string
(Optional) The payload of the notification (only for Jira).
filters This property is required. List<GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilter>
integrationId This property is required. String
(Required) The ID of the integration.
outputType This property is required. String
(Optional) The output type of the integration.
payload This property is required. String
(Optional) The payload of the notification (only for Jira).
filters This property is required. GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilter[]
integrationId This property is required. string
(Required) The ID of the integration.
outputType This property is required. string
(Optional) The output type of the integration.
payload This property is required. string
(Optional) The payload of the notification (only for Jira).
filters This property is required. Sequence[GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilter]
integration_id This property is required. str
(Required) The ID of the integration.
output_type This property is required. str
(Optional) The output type of the integration.
payload This property is required. str
(Optional) The payload of the notification (only for Jira).
filters This property is required. List<Property Map>
integrationId This property is required. String
(Required) The ID of the integration.
outputType This property is required. String
(Optional) The output type of the integration.
payload This property is required. String
(Optional) The payload of the notification (only for Jira).

GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilter

EntityCategories This property is required. List<string>
EntityIds This property is required. List<string>
EntityNames This property is required. List<string>
EntityTags This property is required. List<GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilterEntityTag>
RuleEntityTypes This property is required. List<string>
Severities This property is required. List<string>
EntityCategories This property is required. []string
EntityIds This property is required. []string
EntityNames This property is required. []string
EntityTags This property is required. []GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilterEntityTag
RuleEntityTypes This property is required. []string
Severities This property is required. []string
entityCategories This property is required. List<String>
entityIds This property is required. List<String>
entityNames This property is required. List<String>
entityTags This property is required. List<GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilterEntityTag>
ruleEntityTypes This property is required. List<String>
severities This property is required. List<String>
entityCategories This property is required. string[]
entityIds This property is required. string[]
entityNames This property is required. string[]
entityTags This property is required. GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilterEntityTag[]
ruleEntityTypes This property is required. string[]
severities This property is required. string[]
entity_categories This property is required. Sequence[str]
entity_ids This property is required. Sequence[str]
entity_names This property is required. Sequence[str]
entity_tags This property is required. Sequence[GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilterEntityTag]
rule_entity_types This property is required. Sequence[str]
severities This property is required. Sequence[str]
entityCategories This property is required. List<String>
entityIds This property is required. List<String>
entityNames This property is required. List<String>
entityTags This property is required. List<Property Map>
ruleEntityTypes This property is required. List<String>
severities This property is required. List<String>

GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilterEntityTag

Key This property is required. string
Value This property is required. string
Key This property is required. string
Value This property is required. string
key This property is required. String
value This property is required. String
key This property is required. string
value This property is required. string
key This property is required. str
value This property is required. str
key This property is required. String
value This property is required. String

Package Details

Repository
dome9 dome9/terraform-provider-dome9
License
Notes
This Pulumi package is based on the dome9 Terraform Provider.