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

dome9.Notification

Explore with Pulumi AI

—

layout: “dome9” page_title: “Check Point CloudGuard: dome9.Notification” sidebar_current: “docs-resource-dome9-notification” description: |- Creates and manages Dome9 notifications.

dome9_notification

This resource is used to create and manage CloudGuard notifications. Notifications in CloudGuard allow you to send alerts based on specific events or criteria to various destinations such as email, Slack, or an HTTP endpoint.

Example Usage

Basic usage:

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

const exampleNotification = new dome9.Notification("exampleNotification", {
    alertsConsole: true,
    description: "This is an example notification.",
    integrationSettings: {
        reportsIntegrationSettings: [{
            integrationId: "example-integration-id-2",
            outputType: "Default",
        }],
        scheduledIntegrationSettings: [{
            cronExpression: "0 0 22 * * ?",
            integrationId: "example-integration-id-3",
            outputType: "Detailed",
        }],
        singleNotificationIntegrationSettings: [{
            integrationId: "example-integration-id-1",
            outputType: "Default",
        }],
    },
    sendOnEachOccurrence: false,
});
Copy
import pulumi
import pulumi_dome9 as dome9

example_notification = dome9.Notification("exampleNotification",
    alerts_console=True,
    description="This is an example notification.",
    integration_settings={
        "reports_integration_settings": [{
            "integration_id": "example-integration-id-2",
            "output_type": "Default",
        }],
        "scheduled_integration_settings": [{
            "cron_expression": "0 0 22 * * ?",
            "integration_id": "example-integration-id-3",
            "output_type": "Detailed",
        }],
        "single_notification_integration_settings": [{
            "integration_id": "example-integration-id-1",
            "output_type": "Default",
        }],
    },
    send_on_each_occurrence=False)
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 {
		_, err := dome9.NewNotification(ctx, "exampleNotification", &dome9.NotificationArgs{
			AlertsConsole: pulumi.Bool(true),
			Description:   pulumi.String("This is an example notification."),
			IntegrationSettings: &dome9.NotificationIntegrationSettingsArgs{
				ReportsIntegrationSettings: dome9.NotificationIntegrationSettingsReportsIntegrationSettingArray{
					&dome9.NotificationIntegrationSettingsReportsIntegrationSettingArgs{
						IntegrationId: pulumi.String("example-integration-id-2"),
						OutputType:    pulumi.String("Default"),
					},
				},
				ScheduledIntegrationSettings: dome9.NotificationIntegrationSettingsScheduledIntegrationSettingArray{
					&dome9.NotificationIntegrationSettingsScheduledIntegrationSettingArgs{
						CronExpression: pulumi.String("0 0 22 * * ?"),
						IntegrationId:  pulumi.String("example-integration-id-3"),
						OutputType:     pulumi.String("Detailed"),
					},
				},
				SingleNotificationIntegrationSettings: dome9.NotificationIntegrationSettingsSingleNotificationIntegrationSettingArray{
					&dome9.NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs{
						IntegrationId: pulumi.String("example-integration-id-1"),
						OutputType:    pulumi.String("Default"),
					},
				},
			},
			SendOnEachOccurrence: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Dome9 = Pulumi.Dome9;

return await Deployment.RunAsync(() => 
{
    var exampleNotification = new Dome9.Notification("exampleNotification", new()
    {
        AlertsConsole = true,
        Description = "This is an example notification.",
        IntegrationSettings = new Dome9.Inputs.NotificationIntegrationSettingsArgs
        {
            ReportsIntegrationSettings = new[]
            {
                new Dome9.Inputs.NotificationIntegrationSettingsReportsIntegrationSettingArgs
                {
                    IntegrationId = "example-integration-id-2",
                    OutputType = "Default",
                },
            },
            ScheduledIntegrationSettings = new[]
            {
                new Dome9.Inputs.NotificationIntegrationSettingsScheduledIntegrationSettingArgs
                {
                    CronExpression = "0 0 22 * * ?",
                    IntegrationId = "example-integration-id-3",
                    OutputType = "Detailed",
                },
            },
            SingleNotificationIntegrationSettings = new[]
            {
                new Dome9.Inputs.NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs
                {
                    IntegrationId = "example-integration-id-1",
                    OutputType = "Default",
                },
            },
        },
        SendOnEachOccurrence = false,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dome9.Notification;
import com.pulumi.dome9.NotificationArgs;
import com.pulumi.dome9.inputs.NotificationIntegrationSettingsArgs;
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) {
        var exampleNotification = new Notification("exampleNotification", NotificationArgs.builder()
            .alertsConsole(true)
            .description("This is an example notification.")
            .integrationSettings(NotificationIntegrationSettingsArgs.builder()
                .reportsIntegrationSettings(NotificationIntegrationSettingsReportsIntegrationSettingArgs.builder()
                    .integrationId("example-integration-id-2")
                    .outputType("Default")
                    .build())
                .scheduledIntegrationSettings(NotificationIntegrationSettingsScheduledIntegrationSettingArgs.builder()
                    .cronExpression("0 0 22 * * ?")
                    .integrationId("example-integration-id-3")
                    .outputType("Detailed")
                    .build())
                .singleNotificationIntegrationSettings(NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs.builder()
                    .integrationId("example-integration-id-1")
                    .outputType("Default")
                    .build())
                .build())
            .sendOnEachOccurrence(false)
            .build());

    }
}
Copy
resources:
  exampleNotification:
    type: dome9:Notification
    properties:
      alertsConsole: true
      description: This is an example notification.
      integrationSettings:
        reportsIntegrationSettings:
          - integrationId: example-integration-id-2
            outputType: Default
        scheduledIntegrationSettings:
          - cronExpression: 0 0 22 * * ?
            integrationId: example-integration-id-3
            outputType: Detailed
        singleNotificationIntegrationSettings:
          - integrationId: example-integration-id-1
            outputType: Default
      sendOnEachOccurrence: false
Copy

Create Notification Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Notification(name: string, args?: NotificationArgs, opts?: CustomResourceOptions);
@overload
def Notification(resource_name: str,
                 args: Optional[NotificationArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def Notification(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 alerts_console: Optional[bool] = None,
                 description: Optional[str] = None,
                 integration_settings: Optional[NotificationIntegrationSettingsArgs] = None,
                 name: Optional[str] = None,
                 notification_id: Optional[str] = None,
                 origin: Optional[str] = None,
                 send_on_each_occurrence: Optional[bool] = None)
func NewNotification(ctx *Context, name string, args *NotificationArgs, opts ...ResourceOption) (*Notification, error)
public Notification(string name, NotificationArgs? args = null, CustomResourceOptions? opts = null)
public Notification(String name, NotificationArgs args)
public Notification(String name, NotificationArgs args, CustomResourceOptions options)
type: dome9:Notification
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args NotificationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args NotificationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args NotificationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args NotificationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NotificationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var notificationResource = new Dome9.Notification("notificationResource", new()
{
    AlertsConsole = false,
    Description = "string",
    IntegrationSettings = new Dome9.Inputs.NotificationIntegrationSettingsArgs
    {
        ReportsIntegrationSettings = new[]
        {
            new Dome9.Inputs.NotificationIntegrationSettingsReportsIntegrationSettingArgs
            {
                Filters = new[]
                {
                    new Dome9.Inputs.NotificationIntegrationSettingsReportsIntegrationSettingFilterArgs
                    {
                        EntityCategories = new[]
                        {
                            "string",
                        },
                        EntityIds = new[]
                        {
                            "string",
                        },
                        EntityNames = new[]
                        {
                            "string",
                        },
                        EntityTags = new[]
                        {
                            new Dome9.Inputs.NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTagArgs
                            {
                                Key = "string",
                                Value = "string",
                            },
                        },
                        RuleEntityTypes = new[]
                        {
                            "string",
                        },
                        Severities = new[]
                        {
                            "string",
                        },
                    },
                },
                IntegrationId = "string",
                OutputType = "string",
            },
        },
        ScheduledIntegrationSettings = new[]
        {
            new Dome9.Inputs.NotificationIntegrationSettingsScheduledIntegrationSettingArgs
            {
                CronExpression = "string",
                Filters = new[]
                {
                    new Dome9.Inputs.NotificationIntegrationSettingsScheduledIntegrationSettingFilterArgs
                    {
                        EntityCategories = new[]
                        {
                            "string",
                        },
                        EntityIds = new[]
                        {
                            "string",
                        },
                        EntityNames = new[]
                        {
                            "string",
                        },
                        EntityTags = new[]
                        {
                            new Dome9.Inputs.NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTagArgs
                            {
                                Key = "string",
                                Value = "string",
                            },
                        },
                        RuleEntityTypes = new[]
                        {
                            "string",
                        },
                        Severities = new[]
                        {
                            "string",
                        },
                    },
                },
                IntegrationId = "string",
                OutputType = "string",
            },
        },
        SingleNotificationIntegrationSettings = new[]
        {
            new Dome9.Inputs.NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs
            {
                Filters = new[]
                {
                    new Dome9.Inputs.NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterArgs
                    {
                        EntityCategories = new[]
                        {
                            "string",
                        },
                        EntityIds = new[]
                        {
                            "string",
                        },
                        EntityNames = new[]
                        {
                            "string",
                        },
                        EntityTags = new[]
                        {
                            new Dome9.Inputs.NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTagArgs
                            {
                                Key = "string",
                                Value = "string",
                            },
                        },
                        RuleEntityTypes = new[]
                        {
                            "string",
                        },
                        Severities = new[]
                        {
                            "string",
                        },
                    },
                },
                IntegrationId = "string",
                OutputType = "string",
                Payload = "string",
            },
        },
    },
    Name = "string",
    NotificationId = "string",
    Origin = "string",
    SendOnEachOccurrence = false,
});
Copy
example, err := dome9.NewNotification(ctx, "notificationResource", &dome9.NotificationArgs{
AlertsConsole: pulumi.Bool(false),
Description: pulumi.String("string"),
IntegrationSettings: &.NotificationIntegrationSettingsArgs{
ReportsIntegrationSettings: .NotificationIntegrationSettingsReportsIntegrationSettingArray{
&.NotificationIntegrationSettingsReportsIntegrationSettingArgs{
Filters: .NotificationIntegrationSettingsReportsIntegrationSettingFilterArray{
&.NotificationIntegrationSettingsReportsIntegrationSettingFilterArgs{
EntityCategories: pulumi.StringArray{
pulumi.String("string"),
},
EntityIds: pulumi.StringArray{
pulumi.String("string"),
},
EntityNames: pulumi.StringArray{
pulumi.String("string"),
},
EntityTags: .NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTagArray{
&.NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
RuleEntityTypes: pulumi.StringArray{
pulumi.String("string"),
},
Severities: pulumi.StringArray{
pulumi.String("string"),
},
},
},
IntegrationId: pulumi.String("string"),
OutputType: pulumi.String("string"),
},
},
ScheduledIntegrationSettings: .NotificationIntegrationSettingsScheduledIntegrationSettingArray{
&.NotificationIntegrationSettingsScheduledIntegrationSettingArgs{
CronExpression: pulumi.String("string"),
Filters: .NotificationIntegrationSettingsScheduledIntegrationSettingFilterArray{
&.NotificationIntegrationSettingsScheduledIntegrationSettingFilterArgs{
EntityCategories: pulumi.StringArray{
pulumi.String("string"),
},
EntityIds: pulumi.StringArray{
pulumi.String("string"),
},
EntityNames: pulumi.StringArray{
pulumi.String("string"),
},
EntityTags: .NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTagArray{
&.NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
RuleEntityTypes: pulumi.StringArray{
pulumi.String("string"),
},
Severities: pulumi.StringArray{
pulumi.String("string"),
},
},
},
IntegrationId: pulumi.String("string"),
OutputType: pulumi.String("string"),
},
},
SingleNotificationIntegrationSettings: .NotificationIntegrationSettingsSingleNotificationIntegrationSettingArray{
&.NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs{
Filters: .NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterArray{
&.NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterArgs{
EntityCategories: pulumi.StringArray{
pulumi.String("string"),
},
EntityIds: pulumi.StringArray{
pulumi.String("string"),
},
EntityNames: pulumi.StringArray{
pulumi.String("string"),
},
EntityTags: .NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTagArray{
&.NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
RuleEntityTypes: pulumi.StringArray{
pulumi.String("string"),
},
Severities: pulumi.StringArray{
pulumi.String("string"),
},
},
},
IntegrationId: pulumi.String("string"),
OutputType: pulumi.String("string"),
Payload: pulumi.String("string"),
},
},
},
Name: pulumi.String("string"),
NotificationId: pulumi.String("string"),
Origin: pulumi.String("string"),
SendOnEachOccurrence: pulumi.Bool(false),
})
Copy
var notificationResource = new Notification("notificationResource", NotificationArgs.builder()
    .alertsConsole(false)
    .description("string")
    .integrationSettings(NotificationIntegrationSettingsArgs.builder()
        .reportsIntegrationSettings(NotificationIntegrationSettingsReportsIntegrationSettingArgs.builder()
            .filters(NotificationIntegrationSettingsReportsIntegrationSettingFilterArgs.builder()
                .entityCategories("string")
                .entityIds("string")
                .entityNames("string")
                .entityTags(NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTagArgs.builder()
                    .key("string")
                    .value("string")
                    .build())
                .ruleEntityTypes("string")
                .severities("string")
                .build())
            .integrationId("string")
            .outputType("string")
            .build())
        .scheduledIntegrationSettings(NotificationIntegrationSettingsScheduledIntegrationSettingArgs.builder()
            .cronExpression("string")
            .filters(NotificationIntegrationSettingsScheduledIntegrationSettingFilterArgs.builder()
                .entityCategories("string")
                .entityIds("string")
                .entityNames("string")
                .entityTags(NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTagArgs.builder()
                    .key("string")
                    .value("string")
                    .build())
                .ruleEntityTypes("string")
                .severities("string")
                .build())
            .integrationId("string")
            .outputType("string")
            .build())
        .singleNotificationIntegrationSettings(NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs.builder()
            .filters(NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterArgs.builder()
                .entityCategories("string")
                .entityIds("string")
                .entityNames("string")
                .entityTags(NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTagArgs.builder()
                    .key("string")
                    .value("string")
                    .build())
                .ruleEntityTypes("string")
                .severities("string")
                .build())
            .integrationId("string")
            .outputType("string")
            .payload("string")
            .build())
        .build())
    .name("string")
    .notificationId("string")
    .origin("string")
    .sendOnEachOccurrence(false)
    .build());
Copy
notification_resource = dome9.Notification("notificationResource",
    alerts_console=False,
    description="string",
    integration_settings={
        "reports_integration_settings": [{
            "filters": [{
                "entity_categories": ["string"],
                "entity_ids": ["string"],
                "entity_names": ["string"],
                "entity_tags": [{
                    "key": "string",
                    "value": "string",
                }],
                "rule_entity_types": ["string"],
                "severities": ["string"],
            }],
            "integration_id": "string",
            "output_type": "string",
        }],
        "scheduled_integration_settings": [{
            "cron_expression": "string",
            "filters": [{
                "entity_categories": ["string"],
                "entity_ids": ["string"],
                "entity_names": ["string"],
                "entity_tags": [{
                    "key": "string",
                    "value": "string",
                }],
                "rule_entity_types": ["string"],
                "severities": ["string"],
            }],
            "integration_id": "string",
            "output_type": "string",
        }],
        "single_notification_integration_settings": [{
            "filters": [{
                "entity_categories": ["string"],
                "entity_ids": ["string"],
                "entity_names": ["string"],
                "entity_tags": [{
                    "key": "string",
                    "value": "string",
                }],
                "rule_entity_types": ["string"],
                "severities": ["string"],
            }],
            "integration_id": "string",
            "output_type": "string",
            "payload": "string",
        }],
    },
    name="string",
    notification_id="string",
    origin="string",
    send_on_each_occurrence=False)
Copy
const notificationResource = new dome9.Notification("notificationResource", {
    alertsConsole: false,
    description: "string",
    integrationSettings: {
        reportsIntegrationSettings: [{
            filters: [{
                entityCategories: ["string"],
                entityIds: ["string"],
                entityNames: ["string"],
                entityTags: [{
                    key: "string",
                    value: "string",
                }],
                ruleEntityTypes: ["string"],
                severities: ["string"],
            }],
            integrationId: "string",
            outputType: "string",
        }],
        scheduledIntegrationSettings: [{
            cronExpression: "string",
            filters: [{
                entityCategories: ["string"],
                entityIds: ["string"],
                entityNames: ["string"],
                entityTags: [{
                    key: "string",
                    value: "string",
                }],
                ruleEntityTypes: ["string"],
                severities: ["string"],
            }],
            integrationId: "string",
            outputType: "string",
        }],
        singleNotificationIntegrationSettings: [{
            filters: [{
                entityCategories: ["string"],
                entityIds: ["string"],
                entityNames: ["string"],
                entityTags: [{
                    key: "string",
                    value: "string",
                }],
                ruleEntityTypes: ["string"],
                severities: ["string"],
            }],
            integrationId: "string",
            outputType: "string",
            payload: "string",
        }],
    },
    name: "string",
    notificationId: "string",
    origin: "string",
    sendOnEachOccurrence: false,
});
Copy
type: dome9:Notification
properties:
    alertsConsole: false
    description: string
    integrationSettings:
        reportsIntegrationSettings:
            - filters:
                - entityCategories:
                    - string
                  entityIds:
                    - string
                  entityNames:
                    - string
                  entityTags:
                    - key: string
                      value: string
                  ruleEntityTypes:
                    - string
                  severities:
                    - string
              integrationId: string
              outputType: string
        scheduledIntegrationSettings:
            - cronExpression: string
              filters:
                - entityCategories:
                    - string
                  entityIds:
                    - string
                  entityNames:
                    - string
                  entityTags:
                    - key: string
                      value: string
                  ruleEntityTypes:
                    - string
                  severities:
                    - string
              integrationId: string
              outputType: string
        singleNotificationIntegrationSettings:
            - filters:
                - entityCategories:
                    - string
                  entityIds:
                    - string
                  entityNames:
                    - string
                  entityTags:
                    - key: string
                      value: string
                  ruleEntityTypes:
                    - string
                  severities:
                    - string
              integrationId: string
              outputType: string
              payload: string
    name: string
    notificationId: string
    origin: string
    sendOnEachOccurrence: false
Copy

Notification Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Notification resource accepts the following input properties:

AlertsConsole bool
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
Description string
A description of the notification.
IntegrationSettings NotificationIntegrationSettings
A block of integration settings for the notification. The block supports:
Name string
The name of the notification.
NotificationId string
Origin string
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
SendOnEachOccurrence bool
Boolean flag to send notifications on each occurrence. Defaults to false.
AlertsConsole bool
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
Description string
A description of the notification.
IntegrationSettings NotificationIntegrationSettingsArgs
A block of integration settings for the notification. The block supports:
Name string
The name of the notification.
NotificationId string
Origin string
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
SendOnEachOccurrence bool
Boolean flag to send notifications on each occurrence. Defaults to false.
alertsConsole Boolean
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
description String
A description of the notification.
integrationSettings NotificationIntegrationSettings
A block of integration settings for the notification. The block supports:
name String
The name of the notification.
notificationId String
origin String
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
sendOnEachOccurrence Boolean
Boolean flag to send notifications on each occurrence. Defaults to false.
alertsConsole boolean
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
description string
A description of the notification.
integrationSettings NotificationIntegrationSettings
A block of integration settings for the notification. The block supports:
name string
The name of the notification.
notificationId string
origin string
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
sendOnEachOccurrence boolean
Boolean flag to send notifications on each occurrence. Defaults to false.
alerts_console bool
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
description str
A description of the notification.
integration_settings NotificationIntegrationSettingsArgs
A block of integration settings for the notification. The block supports:
name str
The name of the notification.
notification_id str
origin str
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
send_on_each_occurrence bool
Boolean flag to send notifications on each occurrence. Defaults to false.
alertsConsole Boolean
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
description String
A description of the notification.
integrationSettings Property Map
A block of integration settings for the notification. The block supports:
name String
The name of the notification.
notificationId String
origin String
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
sendOnEachOccurrence Boolean
Boolean flag to send notifications on each occurrence. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the Notification resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Notification Resource

Get an existing Notification resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NotificationState, opts?: CustomResourceOptions): Notification
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alerts_console: Optional[bool] = None,
        description: Optional[str] = None,
        integration_settings: Optional[NotificationIntegrationSettingsArgs] = None,
        name: Optional[str] = None,
        notification_id: Optional[str] = None,
        origin: Optional[str] = None,
        send_on_each_occurrence: Optional[bool] = None) -> Notification
func GetNotification(ctx *Context, name string, id IDInput, state *NotificationState, opts ...ResourceOption) (*Notification, error)
public static Notification Get(string name, Input<string> id, NotificationState? state, CustomResourceOptions? opts = null)
public static Notification get(String name, Output<String> id, NotificationState state, CustomResourceOptions options)
resources:  _:    type: dome9:Notification    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AlertsConsole bool
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
Description string
A description of the notification.
IntegrationSettings NotificationIntegrationSettings
A block of integration settings for the notification. The block supports:
Name string
The name of the notification.
NotificationId string
Origin string
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
SendOnEachOccurrence bool
Boolean flag to send notifications on each occurrence. Defaults to false.
AlertsConsole bool
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
Description string
A description of the notification.
IntegrationSettings NotificationIntegrationSettingsArgs
A block of integration settings for the notification. The block supports:
Name string
The name of the notification.
NotificationId string
Origin string
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
SendOnEachOccurrence bool
Boolean flag to send notifications on each occurrence. Defaults to false.
alertsConsole Boolean
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
description String
A description of the notification.
integrationSettings NotificationIntegrationSettings
A block of integration settings for the notification. The block supports:
name String
The name of the notification.
notificationId String
origin String
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
sendOnEachOccurrence Boolean
Boolean flag to send notifications on each occurrence. Defaults to false.
alertsConsole boolean
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
description string
A description of the notification.
integrationSettings NotificationIntegrationSettings
A block of integration settings for the notification. The block supports:
name string
The name of the notification.
notificationId string
origin string
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
sendOnEachOccurrence boolean
Boolean flag to send notifications on each occurrence. Defaults to false.
alerts_console bool
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
description str
A description of the notification.
integration_settings NotificationIntegrationSettingsArgs
A block of integration settings for the notification. The block supports:
name str
The name of the notification.
notification_id str
origin str
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
send_on_each_occurrence bool
Boolean flag to send notifications on each occurrence. Defaults to false.
alertsConsole Boolean
Boolean flag to send alerts to the CloudGuard event page console. Defaults to true.
description String
A description of the notification.
integrationSettings Property Map
A block of integration settings for the notification. The block supports:
name String
The name of the notification.
notificationId String
origin String
Specifies the source of the notification. Currently, only "ComplianceEngine" is supported as the default value.
sendOnEachOccurrence Boolean
Boolean flag to send notifications on each occurrence. Defaults to false.

Supporting Types

NotificationIntegrationSettings
, NotificationIntegrationSettingsArgs

reportsIntegrationSettings List<Property Map>
A list of report integration settings blocks.
scheduledIntegrationSettings List<Property Map>
A list of scheduled notification integration settings blocks.
singleNotificationIntegrationSettings List<Property Map>
A list of single notification integration settings blocks.

NotificationIntegrationSettingsReportsIntegrationSetting
, NotificationIntegrationSettingsReportsIntegrationSettingArgs

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

NotificationIntegrationSettingsReportsIntegrationSettingFilter
, NotificationIntegrationSettingsReportsIntegrationSettingFilterArgs

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

NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTag
, NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTagArgs

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

NotificationIntegrationSettingsScheduledIntegrationSetting
, NotificationIntegrationSettingsScheduledIntegrationSettingArgs

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

NotificationIntegrationSettingsScheduledIntegrationSettingFilter
, NotificationIntegrationSettingsScheduledIntegrationSettingFilterArgs

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

NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTag
, NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTagArgs

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

NotificationIntegrationSettingsSingleNotificationIntegrationSetting
, NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs

Filters List<NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilter>
IntegrationId string
The ID of the integration.
OutputType string
The output type of the integration.
Payload string
The payload of the notification.
Filters []NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilter
IntegrationId string
The ID of the integration.
OutputType string
The output type of the integration.
Payload string
The payload of the notification.
filters List<NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilter>
integrationId String
The ID of the integration.
outputType String
The output type of the integration.
payload String
The payload of the notification.
filters NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilter[]
integrationId string
The ID of the integration.
outputType string
The output type of the integration.
payload string
The payload of the notification.
filters Sequence[NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilter]
integration_id str
The ID of the integration.
output_type str
The output type of the integration.
payload str
The payload of the notification.
filters List<Property Map>
integrationId String
The ID of the integration.
outputType String
The output type of the integration.
payload String
The payload of the notification.

NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilter
, NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterArgs

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

NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTag
, NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTagArgs

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

Import

This resource can be imported using the notification ID, which can be found in the Dome9 console.

$ pulumi import dome9:index/notification:Notification example <NOTIFICATION_ID>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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