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

dome9 logo
dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9

    —

    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);
    
    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)
    
    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
    	})
    }
    
    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),
        };
    });
    
    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()));
        }
    }
    
    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}
    

    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>
    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]
    func LookupNotification(ctx *Context, args *LookupNotificationArgs, opts ...InvokeOption) (*LookupNotificationResult, error)
    func LookupNotificationOutput(ctx *Context, args *LookupNotificationOutputArgs, opts ...InvokeOption) LookupNotificationResultOutput

    > 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)
    }
    public static CompletableFuture<GetNotificationResult> getNotification(GetNotificationArgs args, InvokeOptions options)
    public static Output<GetNotificationResult> getNotification(GetNotificationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: dome9:index/getNotification:getNotification
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the Dome9 notification to retrieve information for.
    Id string
    The ID of the Dome9 notification to retrieve information for.
    id String
    The ID of the Dome9 notification to retrieve information for.
    id string
    The ID of the Dome9 notification to retrieve information for.
    id str
    The ID of the Dome9 notification to retrieve information for.
    id 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 List<GetNotificationIntegrationSettingReportsIntegrationSetting>
    (Optional) A list of report integration settings blocks. Each block includes:
    ScheduledIntegrationSettings List<GetNotificationIntegrationSettingScheduledIntegrationSetting>
    (Optional) A list of scheduled notification integration settings blocks. Each block includes:
    SingleNotificationIntegrationSettings List<GetNotificationIntegrationSettingSingleNotificationIntegrationSetting>
    (Optional) A list of single notification integration settings blocks. Each block includes:
    ReportsIntegrationSettings []GetNotificationIntegrationSettingReportsIntegrationSetting
    (Optional) A list of report integration settings blocks. Each block includes:
    ScheduledIntegrationSettings []GetNotificationIntegrationSettingScheduledIntegrationSetting
    (Optional) A list of scheduled notification integration settings blocks. Each block includes:
    SingleNotificationIntegrationSettings []GetNotificationIntegrationSettingSingleNotificationIntegrationSetting
    (Optional) A list of single notification integration settings blocks. Each block includes:
    reportsIntegrationSettings List<GetNotificationIntegrationSettingReportsIntegrationSetting>
    (Optional) A list of report integration settings blocks. Each block includes:
    scheduledIntegrationSettings List<GetNotificationIntegrationSettingScheduledIntegrationSetting>
    (Optional) A list of scheduled notification integration settings blocks. Each block includes:
    singleNotificationIntegrationSettings List<GetNotificationIntegrationSettingSingleNotificationIntegrationSetting>
    (Optional) A list of single notification integration settings blocks. Each block includes:
    reportsIntegrationSettings GetNotificationIntegrationSettingReportsIntegrationSetting[]
    (Optional) A list of report integration settings blocks. Each block includes:
    scheduledIntegrationSettings GetNotificationIntegrationSettingScheduledIntegrationSetting[]
    (Optional) A list of scheduled notification integration settings blocks. Each block includes:
    singleNotificationIntegrationSettings GetNotificationIntegrationSettingSingleNotificationIntegrationSetting[]
    (Optional) A list of single notification integration settings blocks. Each block includes:
    reports_integration_settings Sequence[GetNotificationIntegrationSettingReportsIntegrationSetting]
    (Optional) A list of report integration settings blocks. Each block includes:
    scheduled_integration_settings Sequence[GetNotificationIntegrationSettingScheduledIntegrationSetting]
    (Optional) A list of scheduled notification integration settings blocks. Each block includes:
    single_notification_integration_settings Sequence[GetNotificationIntegrationSettingSingleNotificationIntegrationSetting]
    (Optional) A list of single notification integration settings blocks. Each block includes:
    reportsIntegrationSettings List<Property Map>
    (Optional) A list of report integration settings blocks. Each block includes:
    scheduledIntegrationSettings List<Property Map>
    (Optional) A list of scheduled notification integration settings blocks. Each block includes:
    singleNotificationIntegrationSettings List<Property Map>
    (Optional) A list of single notification integration settings blocks. Each block includes:

    GetNotificationIntegrationSettingReportsIntegrationSetting

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

    GetNotificationIntegrationSettingReportsIntegrationSettingFilter

    entityCategories List<String>
    entityIds List<String>
    entityNames List<String>
    entityTags List<Property Map>
    ruleEntityTypes List<String>
    severities List<String>

    GetNotificationIntegrationSettingReportsIntegrationSettingFilterEntityTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetNotificationIntegrationSettingScheduledIntegrationSetting

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

    GetNotificationIntegrationSettingScheduledIntegrationSettingFilter

    entityCategories List<String>
    entityIds List<String>
    entityNames List<String>
    entityTags List<Property Map>
    ruleEntityTypes List<String>
    severities List<String>

    GetNotificationIntegrationSettingScheduledIntegrationSettingFilterEntityTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetNotificationIntegrationSettingSingleNotificationIntegrationSetting

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

    GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilter

    entityCategories List<String>
    entityIds List<String>
    entityNames List<String>
    entityTags List<Property Map>
    ruleEntityTypes List<String>
    severities List<String>

    GetNotificationIntegrationSettingSingleNotificationIntegrationSettingFilterEntityTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    dome9 dome9/terraform-provider-dome9
    License
    Notes
    This Pulumi package is based on the dome9 Terraform Provider.
    dome9 logo
    dome9 1.40.3 published on Monday, Apr 14, 2025 by dome9