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,
});
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)
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
})
}
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,
});
});
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());
}
}
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
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 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 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 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 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 String
- The unique name of the resource.
- args 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,
});
example, err := dome9.NewNotification(ctx, "notificationResource", &dome9.NotificationArgs{
AlertsConsole: pulumi.Bool(false),
Description: pulumi.String("string"),
IntegrationSettings: &dome9.NotificationIntegrationSettingsArgs{
ReportsIntegrationSettings: dome9.NotificationIntegrationSettingsReportsIntegrationSettingArray{
&dome9.NotificationIntegrationSettingsReportsIntegrationSettingArgs{
Filters: dome9.NotificationIntegrationSettingsReportsIntegrationSettingFilterArray{
&dome9.NotificationIntegrationSettingsReportsIntegrationSettingFilterArgs{
EntityCategories: pulumi.StringArray{
pulumi.String("string"),
},
EntityIds: pulumi.StringArray{
pulumi.String("string"),
},
EntityNames: pulumi.StringArray{
pulumi.String("string"),
},
EntityTags: dome9.NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTagArray{
&dome9.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: dome9.NotificationIntegrationSettingsScheduledIntegrationSettingArray{
&dome9.NotificationIntegrationSettingsScheduledIntegrationSettingArgs{
CronExpression: pulumi.String("string"),
Filters: dome9.NotificationIntegrationSettingsScheduledIntegrationSettingFilterArray{
&dome9.NotificationIntegrationSettingsScheduledIntegrationSettingFilterArgs{
EntityCategories: pulumi.StringArray{
pulumi.String("string"),
},
EntityIds: pulumi.StringArray{
pulumi.String("string"),
},
EntityNames: pulumi.StringArray{
pulumi.String("string"),
},
EntityTags: dome9.NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTagArray{
&dome9.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: dome9.NotificationIntegrationSettingsSingleNotificationIntegrationSettingArray{
&dome9.NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs{
Filters: dome9.NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterArray{
&dome9.NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterArgs{
EntityCategories: pulumi.StringArray{
pulumi.String("string"),
},
EntityIds: pulumi.StringArray{
pulumi.String("string"),
},
EntityNames: pulumi.StringArray{
pulumi.String("string"),
},
EntityTags: dome9.NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTagArray{
&dome9.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),
})
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());
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)
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,
});
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
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:
- Alerts
Console bool - Boolean flag to send alerts to the CloudGuard event page console. Defaults to
true
. - Description string
- A description of the notification.
- Integration
Settings NotificationIntegration Settings - A block of integration settings for the notification. The block supports:
- Name string
- The name of the notification.
- Notification
Id string - Origin string
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - Send
On boolEach Occurrence - 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 string
- A description of the notification.
- Integration
Settings NotificationIntegration Settings Args - A block of integration settings for the notification. The block supports:
- Name string
- The name of the notification.
- Notification
Id string - Origin string
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - Send
On boolEach Occurrence - Boolean flag to send notifications on each occurrence. Defaults to
false
.
- alerts
Console Boolean - Boolean flag to send alerts to the CloudGuard event page console. Defaults to
true
. - description String
- A description of the notification.
- integration
Settings NotificationIntegration Settings - A block of integration settings for the notification. The block supports:
- name String
- The name of the notification.
- notification
Id String - origin String
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - send
On BooleanEach Occurrence - Boolean flag to send notifications on each occurrence. Defaults to
false
.
- alerts
Console boolean - Boolean flag to send alerts to the CloudGuard event page console. Defaults to
true
. - description string
- A description of the notification.
- integration
Settings NotificationIntegration Settings - A block of integration settings for the notification. The block supports:
- name string
- The name of the notification.
- notification
Id string - origin string
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - send
On booleanEach Occurrence - 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 NotificationIntegration Settings Args - 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_ booleach_ occurrence - Boolean flag to send notifications on each occurrence. Defaults to
false
.
- alerts
Console Boolean - Boolean flag to send alerts to the CloudGuard event page console. Defaults to
true
. - description String
- A description of the notification.
- integration
Settings Property Map - A block of integration settings for the notification. The block supports:
- name String
- The name of the notification.
- notification
Id String - origin String
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - send
On BooleanEach Occurrence - 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Alerts
Console bool - Boolean flag to send alerts to the CloudGuard event page console. Defaults to
true
. - Description string
- A description of the notification.
- Integration
Settings NotificationIntegration Settings - A block of integration settings for the notification. The block supports:
- Name string
- The name of the notification.
- Notification
Id string - Origin string
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - Send
On boolEach Occurrence - 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 string
- A description of the notification.
- Integration
Settings NotificationIntegration Settings Args - A block of integration settings for the notification. The block supports:
- Name string
- The name of the notification.
- Notification
Id string - Origin string
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - Send
On boolEach Occurrence - Boolean flag to send notifications on each occurrence. Defaults to
false
.
- alerts
Console Boolean - Boolean flag to send alerts to the CloudGuard event page console. Defaults to
true
. - description String
- A description of the notification.
- integration
Settings NotificationIntegration Settings - A block of integration settings for the notification. The block supports:
- name String
- The name of the notification.
- notification
Id String - origin String
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - send
On BooleanEach Occurrence - Boolean flag to send notifications on each occurrence. Defaults to
false
.
- alerts
Console boolean - Boolean flag to send alerts to the CloudGuard event page console. Defaults to
true
. - description string
- A description of the notification.
- integration
Settings NotificationIntegration Settings - A block of integration settings for the notification. The block supports:
- name string
- The name of the notification.
- notification
Id string - origin string
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - send
On booleanEach Occurrence - 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 NotificationIntegration Settings Args - 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_ booleach_ occurrence - Boolean flag to send notifications on each occurrence. Defaults to
false
.
- alerts
Console Boolean - Boolean flag to send alerts to the CloudGuard event page console. Defaults to
true
. - description String
- A description of the notification.
- integration
Settings Property Map - A block of integration settings for the notification. The block supports:
- name String
- The name of the notification.
- notification
Id String - origin String
- Specifies the source of the notification. Currently, only
"ComplianceEngine"
is supported as the default value. - send
On BooleanEach Occurrence - Boolean flag to send notifications on each occurrence. Defaults to
false
.
Supporting Types
NotificationIntegrationSettings, NotificationIntegrationSettingsArgs
- Reports
Integration List<NotificationSettings Integration Settings Reports Integration Setting> - A list of report integration settings blocks.
- Scheduled
Integration List<NotificationSettings Integration Settings Scheduled Integration Setting> - A list of scheduled notification integration settings blocks.
- Single
Notification List<NotificationIntegration Settings Integration Settings Single Notification Integration Setting> - A list of single notification integration settings blocks.
- Reports
Integration []NotificationSettings Integration Settings Reports Integration Setting - A list of report integration settings blocks.
- Scheduled
Integration []NotificationSettings Integration Settings Scheduled Integration Setting - A list of scheduled notification integration settings blocks.
- Single
Notification []NotificationIntegration Settings Integration Settings Single Notification Integration Setting - A list of single notification integration settings blocks.
- reports
Integration List<NotificationSettings Integration Settings Reports Integration Setting> - A list of report integration settings blocks.
- scheduled
Integration List<NotificationSettings Integration Settings Scheduled Integration Setting> - A list of scheduled notification integration settings blocks.
- single
Notification List<NotificationIntegration Settings Integration Settings Single Notification Integration Setting> - A list of single notification integration settings blocks.
- reports
Integration NotificationSettings Integration Settings Reports Integration Setting[] - A list of report integration settings blocks.
- scheduled
Integration NotificationSettings Integration Settings Scheduled Integration Setting[] - A list of scheduled notification integration settings blocks.
- single
Notification NotificationIntegration Settings Integration Settings Single Notification Integration Setting[] - A list of single notification integration settings blocks.
- reports_
integration_ Sequence[Notificationsettings Integration Settings Reports Integration Setting] - A list of report integration settings blocks.
- scheduled_
integration_ Sequence[Notificationsettings Integration Settings Scheduled Integration Setting] - A list of scheduled notification integration settings blocks.
- single_
notification_ Sequence[Notificationintegration_ settings Integration Settings Single Notification Integration Setting] - A list of single notification integration settings blocks.
- reports
Integration List<Property Map>Settings - A list of report integration settings blocks.
- scheduled
Integration List<Property Map>Settings - A list of scheduled notification integration settings blocks.
- single
Notification List<Property Map>Integration Settings - A list of single notification integration settings blocks.
NotificationIntegrationSettingsReportsIntegrationSetting, NotificationIntegrationSettingsReportsIntegrationSettingArgs
- Filters
List<Notification
Integration Settings Reports Integration Setting Filter> - Integration
Id string - The ID of the integration.
- Output
Type string - The output type of the integration.
- Filters
[]Notification
Integration Settings Reports Integration Setting Filter - Integration
Id string - The ID of the integration.
- Output
Type string - The output type of the integration.
- filters
List<Notification
Integration Settings Reports Integration Setting Filter> - integration
Id String - The ID of the integration.
- output
Type String - The output type of the integration.
- filters
Notification
Integration Settings Reports Integration Setting Filter[] - integration
Id string - The ID of the integration.
- output
Type string - The output type of the integration.
- filters
Sequence[Notification
Integration Settings Reports Integration Setting Filter] - integration_
id str - The ID of the integration.
- output_
type str - The output type of the integration.
- filters List<Property Map>
- integration
Id String - The ID of the integration.
- output
Type String - The output type of the integration.
NotificationIntegrationSettingsReportsIntegrationSettingFilter, NotificationIntegrationSettingsReportsIntegrationSettingFilterArgs
- Entity
Categories List<string> - Entity
Ids List<string> - Entity
Names List<string> - List<Notification
Integration Settings Reports Integration Setting Filter Entity Tag> - Rule
Entity List<string>Types - Severities List<string>
- Entity
Categories []string - Entity
Ids []string - Entity
Names []string - []Notification
Integration Settings Reports Integration Setting Filter Entity Tag - Rule
Entity []stringTypes - Severities []string
- entity
Categories List<String> - entity
Ids List<String> - entity
Names List<String> - List<Notification
Integration Settings Reports Integration Setting Filter Entity Tag> - rule
Entity List<String>Types - severities List<String>
- entity
Categories string[] - entity
Ids string[] - entity
Names string[] - Notification
Integration Settings Reports Integration Setting Filter Entity Tag[] - rule
Entity string[]Types - severities string[]
- entity_
categories Sequence[str] - entity_
ids Sequence[str] - entity_
names Sequence[str] - Sequence[Notification
Integration Settings Reports Integration Setting Filter Entity Tag] - rule_
entity_ Sequence[str]types - severities Sequence[str]
- entity
Categories List<String> - entity
Ids List<String> - entity
Names List<String> - List<Property Map>
- rule
Entity List<String>Types - severities List<String>
NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTag, NotificationIntegrationSettingsReportsIntegrationSettingFilterEntityTagArgs
NotificationIntegrationSettingsScheduledIntegrationSetting, NotificationIntegrationSettingsScheduledIntegrationSettingArgs
- Cron
Expression string - The cron expression for the scheduled notification.
- Filters
List<Notification
Integration Settings Scheduled Integration Setting Filter> - Integration
Id string - The ID of the integration.
- Output
Type string - The output type of the integration.
- Cron
Expression string - The cron expression for the scheduled notification.
- Filters
[]Notification
Integration Settings Scheduled Integration Setting Filter - Integration
Id string - The ID of the integration.
- Output
Type string - The output type of the integration.
- cron
Expression String - The cron expression for the scheduled notification.
- filters
List<Notification
Integration Settings Scheduled Integration Setting Filter> - integration
Id String - The ID of the integration.
- output
Type String - The output type of the integration.
- cron
Expression string - The cron expression for the scheduled notification.
- filters
Notification
Integration Settings Scheduled Integration Setting Filter[] - integration
Id string - The ID of the integration.
- output
Type string - The output type of the integration.
- cron_
expression str - The cron expression for the scheduled notification.
- filters
Sequence[Notification
Integration Settings Scheduled Integration Setting Filter] - integration_
id str - The ID of the integration.
- output_
type str - The output type of the integration.
- cron
Expression String - The cron expression for the scheduled notification.
- filters List<Property Map>
- integration
Id String - The ID of the integration.
- output
Type String - The output type of the integration.
NotificationIntegrationSettingsScheduledIntegrationSettingFilter, NotificationIntegrationSettingsScheduledIntegrationSettingFilterArgs
- Entity
Categories List<string> - Entity
Ids List<string> - Entity
Names List<string> - List<Notification
Integration Settings Scheduled Integration Setting Filter Entity Tag> - Rule
Entity List<string>Types - Severities List<string>
- Entity
Categories []string - Entity
Ids []string - Entity
Names []string - []Notification
Integration Settings Scheduled Integration Setting Filter Entity Tag - Rule
Entity []stringTypes - Severities []string
- entity
Categories List<String> - entity
Ids List<String> - entity
Names List<String> - List<Notification
Integration Settings Scheduled Integration Setting Filter Entity Tag> - rule
Entity List<String>Types - severities List<String>
- entity
Categories string[] - entity
Ids string[] - entity
Names string[] - Notification
Integration Settings Scheduled Integration Setting Filter Entity Tag[] - rule
Entity string[]Types - severities string[]
- entity_
categories Sequence[str] - entity_
ids Sequence[str] - entity_
names Sequence[str] - Sequence[Notification
Integration Settings Scheduled Integration Setting Filter Entity Tag] - rule_
entity_ Sequence[str]types - severities Sequence[str]
- entity
Categories List<String> - entity
Ids List<String> - entity
Names List<String> - List<Property Map>
- rule
Entity List<String>Types - severities List<String>
NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTag, NotificationIntegrationSettingsScheduledIntegrationSettingFilterEntityTagArgs
NotificationIntegrationSettingsSingleNotificationIntegrationSetting, NotificationIntegrationSettingsSingleNotificationIntegrationSettingArgs
- Filters
List<Notification
Integration Settings Single Notification Integration Setting Filter> - Integration
Id string - The ID of the integration.
- Output
Type string - The output type of the integration.
- Payload string
- The payload of the notification.
- Filters
[]Notification
Integration Settings Single Notification Integration Setting Filter - Integration
Id string - The ID of the integration.
- Output
Type string - The output type of the integration.
- Payload string
- The payload of the notification.
- filters
List<Notification
Integration Settings Single Notification Integration Setting Filter> - integration
Id String - The ID of the integration.
- output
Type String - The output type of the integration.
- payload String
- The payload of the notification.
- filters
Notification
Integration Settings Single Notification Integration Setting Filter[] - integration
Id string - The ID of the integration.
- output
Type string - The output type of the integration.
- payload string
- The payload of the notification.
- filters
Sequence[Notification
Integration Settings Single Notification Integration Setting Filter] - 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>
- integration
Id String - The ID of the integration.
- output
Type String - The output type of the integration.
- payload String
- The payload of the notification.
NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilter, NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterArgs
- Entity
Categories List<string> - Entity
Ids List<string> - Entity
Names List<string> - List<Notification
Integration Settings Single Notification Integration Setting Filter Entity Tag> - Rule
Entity List<string>Types - Severities List<string>
- Entity
Categories []string - Entity
Ids []string - Entity
Names []string - []Notification
Integration Settings Single Notification Integration Setting Filter Entity Tag - Rule
Entity []stringTypes - Severities []string
- entity
Categories List<String> - entity
Ids List<String> - entity
Names List<String> - List<Notification
Integration Settings Single Notification Integration Setting Filter Entity Tag> - rule
Entity List<String>Types - severities List<String>
- entity
Categories string[] - entity
Ids string[] - entity
Names string[] - Notification
Integration Settings Single Notification Integration Setting Filter Entity Tag[] - rule
Entity string[]Types - severities string[]
- entity_
categories Sequence[str] - entity_
ids Sequence[str] - entity_
names Sequence[str] - Sequence[Notification
Integration Settings Single Notification Integration Setting Filter Entity Tag] - rule_
entity_ Sequence[str]types - severities Sequence[str]
- entity
Categories List<String> - entity
Ids List<String> - entity
Names List<String> - List<Property Map>
- rule
Entity List<String>Types - severities List<String>
NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTag, NotificationIntegrationSettingsSingleNotificationIntegrationSettingFilterEntityTagArgs
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>
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.