ProjectNotificationConfig 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 ProjectNotificationConfig, see:
- API documentation
- How-to Guides
- Official Documentation
Example Usage
Scc Project Notification Config Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const sccProjectNotification = new gcp.pubsub.Topic("scc_project_notification", {name: "my-topic"});
const customNotificationConfig = new gcp.securitycenter.ProjectNotificationConfig("custom_notification_config", {
configId: "my-config",
project: "my-project-name",
description: "My custom Cloud Security Command Center Finding Notification Configuration",
pubsubTopic: sccProjectNotification.id,
streamingConfig: {
filter: "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
},
});
import pulumi
import pulumi_gcp as gcp
scc_project_notification = gcp.pubsub.Topic("scc_project_notification", name="my-topic")
custom_notification_config = gcp.securitycenter.ProjectNotificationConfig("custom_notification_config",
config_id="my-config",
project="my-project-name",
description="My custom Cloud Security Command Center Finding Notification Configuration",
pubsub_topic=scc_project_notification.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 sccProjectNotification = new Gcp.PubSub.Topic("scc_project_notification", new()
{
Name = "my-topic",
});
var customNotificationConfig = new Gcp.SecurityCenter.ProjectNotificationConfig("custom_notification_config", new()
{
ConfigId = "my-config",
Project = "my-project-name",
Description = "My custom Cloud Security Command Center Finding Notification Configuration",
PubsubTopic = sccProjectNotification.Id,
StreamingConfig = new Gcp.SecurityCenter.Inputs.ProjectNotificationConfigStreamingConfigArgs
{
Filter = "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
},
});
});
package main
import (
"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 {
sccProjectNotification, err := pubsub.NewTopic(ctx, "scc_project_notification", &pubsub.TopicArgs{
Name: pulumi.String("my-topic"),
})
if err != nil {
return err
}
_, err = securitycenter.NewProjectNotificationConfig(ctx, "custom_notification_config", &securitycenter.ProjectNotificationConfigArgs{
ConfigId: pulumi.String("my-config"),
Project: pulumi.String("my-project-name"),
Description: pulumi.String("My custom Cloud Security Command Center Finding Notification Configuration"),
PubsubTopic: sccProjectNotification.ID().ToIDOutput().ToStringOutput(),
StreamingConfig: &securitycenter.ProjectNotificationConfigStreamingConfigArgs{
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_pubsub_topic" "scc_project_notification" {
name = "my-topic"
}
resource "gcp_securitycenter_projectnotificationconfig" "custom_notification_config" {
config_id = "my-config"
project = "my-project-name"
description = "My custom Cloud Security Command Center Finding Notification Configuration"
pubsub_topic = gcp_pubsub_topic.scc_project_notification.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.pubsub.Topic;
import com.pulumi.gcp.pubsub.TopicArgs;
import com.pulumi.gcp.securitycenter.ProjectNotificationConfig;
import com.pulumi.gcp.securitycenter.ProjectNotificationConfigArgs;
import com.pulumi.gcp.securitycenter.inputs.ProjectNotificationConfigStreamingConfigArgs;
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 sccProjectNotification = new Topic("sccProjectNotification", TopicArgs.builder()
.name("my-topic")
.build());
var customNotificationConfig = new ProjectNotificationConfig("customNotificationConfig", ProjectNotificationConfigArgs.builder()
.configId("my-config")
.project("my-project-name")
.description("My custom Cloud Security Command Center Finding Notification Configuration")
.pubsubTopic(sccProjectNotification.id())
.streamingConfig(ProjectNotificationConfigStreamingConfigArgs.builder()
.filter("category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"")
.build())
.build());
}
}
resources:
sccProjectNotification:
type: gcp:pubsub:Topic
name: scc_project_notification
properties:
name: my-topic
customNotificationConfig:
type: gcp:securitycenter:ProjectNotificationConfig
name: custom_notification_config
properties:
configId: my-config
project: my-project-name
description: My custom Cloud Security Command Center Finding Notification Configuration
pubsubTopic: ${sccProjectNotification.id}
streamingConfig:
filter: category = "OPEN_FIREWALL" AND state = "ACTIVE"
Import
ProjectNotificationConfig can be imported using any of these accepted formats:
{{name}}
When using the pulumi import command, ProjectNotificationConfig can be imported using one of the formats above. For example:
$ pulumi import gcp:securitycenter/projectNotificationConfig:ProjectNotificationConfig default {{name}}
Constructors
- ProjectNotificationConfig(String name, {ProjectNotificationConfigArgs? args, CustomResourceOptions? options})
-
Creates a new ProjectNotificationConfig.
nameThe Pulumi resource name.argsArguments used to configure this ProjectNotificationConfig. The set of arguments for ProjectNotificationConfig.optionsResource options controlling this resource's behavior. - ProjectNotificationConfig.reference(String urn)
- Creates a typed reference to an existing ProjectNotificationConfig resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
configId
↔ Output<
String> -
This must be unique within the organization.
latefinal
-
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.
latefinal
-
description
↔ Output<
String?> -
The description of the notification config (max of 1024 characters).
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The resource name of this notification config, in the format
projects/{{projectId}}/notificationConfigs/{{config_id}}.latefinal -
project
↔ Output<
String> -
The ID of the project in which the resource belongs.
If it is not provided, the provider project is used.
latefinal
-
pubsubTopic
↔ Output<
String> -
The Pub/Sub topic to send notifications to. Its format is
"projects/
projectId/topics/topic".latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
serviceAccount
↔ Output<
String> -
The service account that needs "pubsub.topics.publish" permission to
publish to the Pub/Sub topic.
latefinal
-
streamingConfig
↔ Output<
ProjectNotificationConfigStreamingConfig> -
The config for triggering streaming-based notifications.
Structure is documented below.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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, {ProjectNotificationConfigState? state, CustomResourceOptions? options}) → ProjectNotificationConfig -
Gets an existing ProjectNotificationConfig resource's state with the given
nameandid.