FolderNotificationConfig class

A Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. > Note: In order to use Cloud SCC resources, your organization must be enrolled in SCC Standard/Premium. Without doing so, you may run into errors during resource creation.

To get more information about FolderNotificationConfig, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Scc Folder Notification Config Basic

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

const folder = new gcp.organizations.Folder("folder", {
    parent: "organizations/123456789",
    displayName: "folder-name",
});
const sccFolderNotificationConfig = new gcp.pubsub.Topic("scc_folder_notification_config", {name: "my-topic"});
const customNotificationConfig = new gcp.securitycenter.FolderNotificationConfig("custom_notification_config", {
    configId: "my-config",
    folder: folder.folderId,
    location: "global",
    description: "My custom Cloud Security Command Center Finding Notification Configuration",
    pubsubTopic: sccFolderNotificationConfig.id,
    streamingConfig: {
        filter: "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
    },
});

import pulumi
import pulumi_gcp as gcp

folder = gcp.organizations.Folder("folder",
    parent="organizations/123456789",
    display_name="folder-name")
scc_folder_notification_config = gcp.pubsub.Topic("scc_folder_notification_config", name="my-topic")
custom_notification_config = gcp.securitycenter.FolderNotificationConfig("custom_notification_config",
    config_id="my-config",
    folder=folder.folder_id,
    location="global",
    description="My custom Cloud Security Command Center Finding Notification Configuration",
    pubsub_topic=scc_folder_notification_config.id,
    streaming_config={
        "filter": "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var folder = new Gcp.Organizations.Folder("folder", new()
    {
        Parent = "organizations/123456789",
        DisplayName = "folder-name",
    });

    var sccFolderNotificationConfig = new Gcp.PubSub.Topic("scc_folder_notification_config", new()
    {
        Name = "my-topic",
    });

    var customNotificationConfig = new Gcp.SecurityCenter.FolderNotificationConfig("custom_notification_config", new()
    {
        ConfigId = "my-config",
        Folder = folder.FolderId,
        Location = "global",
        Description = "My custom Cloud Security Command Center Finding Notification Configuration",
        PubsubTopic = sccFolderNotificationConfig.Id,
        StreamingConfig = new Gcp.SecurityCenter.Inputs.FolderNotificationConfigStreamingConfigArgs
        {
            Filter = "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/pubsub"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/securitycenter"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		folder, err := organizations.NewFolder(ctx, "folder", &organizations.FolderArgs{
			Parent:      pulumi.String("organizations/123456789"),
			DisplayName: pulumi.String("folder-name"),
		})
		if err != nil {
			return err
		}
		sccFolderNotificationConfig, err := pubsub.NewTopic(ctx, "scc_folder_notification_config", &pubsub.TopicArgs{
			Name: pulumi.String("my-topic"),
		})
		if err != nil {
			return err
		}
		_, err = securitycenter.NewFolderNotificationConfig(ctx, "custom_notification_config", &securitycenter.FolderNotificationConfigArgs{
			ConfigId:    pulumi.String("my-config"),
			Folder:      folder.FolderId,
			Location:    "global",
			Description: pulumi.String("My custom Cloud Security Command Center Finding Notification Configuration"),
			PubsubTopic: sccFolderNotificationConfig.ID().ToIDOutput().ToStringOutput(),
			StreamingConfig: &securitycenter.FolderNotificationConfigStreamingConfigArgs{
				Filter: pulumi.String("category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\""),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_organizations_folder" "folder" {
  parent       = "organizations/123456789"
  display_name = "folder-name"
}
resource "gcp_pubsub_topic" "scc_folder_notification_config" {
  name = "my-topic"
}
resource "gcp_securitycenter_foldernotificationconfig" "custom_notification_config" {
  config_id    = "my-config"
  folder       = gcp_organizations_folder.folder.folder_id
  location     = "global"
  description  = "My custom Cloud Security Command Center Finding Notification Configuration"
  pubsub_topic = gcp_pubsub_topic.scc_folder_notification_config.id
  streaming_config = {
    filter = "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\""
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Folder;
import com.pulumi.gcp.organizations.FolderArgs;
import com.pulumi.gcp.pubsub.Topic;
import com.pulumi.gcp.pubsub.TopicArgs;
import com.pulumi.gcp.securitycenter.FolderNotificationConfig;
import com.pulumi.gcp.securitycenter.FolderNotificationConfigArgs;
import com.pulumi.gcp.securitycenter.inputs.FolderNotificationConfigStreamingConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 folder = new Folder("folder", FolderArgs.builder()
            .parent("organizations/123456789")
            .displayName("folder-name")
            .build());

        var sccFolderNotificationConfig = new Topic("sccFolderNotificationConfig", TopicArgs.builder()
            .name("my-topic")
            .build());

        var customNotificationConfig = new FolderNotificationConfig("customNotificationConfig", FolderNotificationConfigArgs.builder()
            .configId("my-config")
            .folder(folder.folderId())
            .location("global")
            .description("My custom Cloud Security Command Center Finding Notification Configuration")
            .pubsubTopic(sccFolderNotificationConfig.id())
            .streamingConfig(FolderNotificationConfigStreamingConfigArgs.builder()
                .filter("category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"")
                .build())
            .build());

    }
}

resources:
  folder:
    type: gcp:organizations:Folder
    properties:
      parent: organizations/123456789
      displayName: folder-name
  sccFolderNotificationConfig:
    type: gcp:pubsub:Topic
    name: scc_folder_notification_config
    properties:
      name: my-topic
  customNotificationConfig:
    type: gcp:securitycenter:FolderNotificationConfig
    name: custom_notification_config
    properties:
      configId: my-config
      folder: ${folder.folderId}
      location: global
      description: My custom Cloud Security Command Center Finding Notification Configuration
      pubsubTopic: ${sccFolderNotificationConfig.id}
      streamingConfig:
        filter: category = "OPEN_FIREWALL" AND state = "ACTIVE"

Import

FolderNotificationConfig can be imported using any of these accepted formats:

• folders/{{folder}}/notificationConfigs/{{config_id}}
• {{folder}}/{{config_id}}

When using the pulumi import command, FolderNotificationConfig can be imported using one of the formats above. For example:

$ pulumi import gcp:securitycenter/folderNotificationConfig:FolderNotificationConfig default folders/{{folder}}/notificationConfigs/{{config_id}}
$ pulumi import gcp:securitycenter/folderNotificationConfig:FolderNotificationConfig default {{folder}}/{{config_id}}

Constructors

FolderNotificationConfig(String name, {FolderNotificationConfigArgs? args, CustomResourceOptions? options})

Creates a new FolderNotificationConfig. name The Pulumi resource name. args Arguments used to configure this FolderNotificationConfig. The set of arguments for FolderNotificationConfig. options Resource options controlling this resource's behavior.

FolderNotificationConfig.reference(String urn)

Creates a typed reference to an existing FolderNotificationConfig resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

configId ↔ Output<String>

This must be unique within the organization.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

The description of the notification config (max of 1024 characters).

late, final

folder ↔ Output<String>

Numerical ID of the parent folder.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The resource name of this notification config, in the format folders/{{folder}}/notificationConfigs/{{config_id}}.

late, final

pubsubTopic ↔ Output<String>

The Pub/Sub topic to send notifications to. Its format is "projects/projectId/topics/topic".

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceAccount ↔ Output<String>

The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.

late, final

streamingConfig ↔ Output<FolderNotificationConfigStreamingConfig>

The config for triggering streaming-based notifications. Structure is documented below.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {FolderNotificationConfigState? state, CustomResourceOptions? options}) → FolderNotificationConfig

Gets an existing FolderNotificationConfig resource's state with the given name and id.