com.pulumi.gcp.securitycenter.kotlin.V2FolderNotificationConfigArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.securitycenter.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.securitycenter.V2FolderNotificationConfigArgs.builder
import com.pulumi.gcp.securitycenter.kotlin.inputs.V2FolderNotificationConfigStreamingConfigArgs
import com.pulumi.gcp.securitycenter.kotlin.inputs.V2FolderNotificationConfigStreamingConfigArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName
/**
* 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](https://cloud.google.com/security-command-center/docs/quickstart-security-command-center).
* Without doing so, you may run into errors during resource creation.
* To get more information about FolderNotificationConfig, see:
* * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v2/folders.locations.notificationConfigs)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/security-command-center/docs)
* ## Example Usage
* ### Scc V2 Folder Notification Config Basic
*
* ```typescript
* 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 sccV2FolderNotificationConfig = new gcp.pubsub.Topic("scc_v2_folder_notification_config", {name: "my-topic"});
* const customNotificationConfig = new gcp.securitycenter.V2FolderNotificationConfig("custom_notification_config", {
* configId: "my-config",
* folder: folder.folderId,
* location: "global",
* description: "My custom Cloud Security Command Center Finding Notification Configuration",
* pubsubTopic: sccV2FolderNotificationConfig.id,
* streamingConfig: {
* filter: "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* folder = gcp.organizations.Folder("folder",
* parent="organizations/123456789",
* display_name="folder-name")
* scc_v2_folder_notification_config = gcp.pubsub.Topic("scc_v2_folder_notification_config", name="my-topic")
* custom_notification_config = gcp.securitycenter.V2FolderNotificationConfig("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_v2_folder_notification_config.id,
* streaming_config={
* "filter": "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
* })
* ```
* ```csharp
* 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 sccV2FolderNotificationConfig = new Gcp.PubSub.Topic("scc_v2_folder_notification_config", new()
* {
* Name = "my-topic",
* });
* var customNotificationConfig = new Gcp.SecurityCenter.V2FolderNotificationConfig("custom_notification_config", new()
* {
* ConfigId = "my-config",
* Folder = folder.FolderId,
* Location = "global",
* Description = "My custom Cloud Security Command Center Finding Notification Configuration",
* PubsubTopic = sccV2FolderNotificationConfig.Id,
* StreamingConfig = new Gcp.SecurityCenter.Inputs.V2FolderNotificationConfigStreamingConfigArgs
* {
* Filter = "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/organizations"
* "github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/pubsub"
* "github.com/pulumi/pulumi-gcp/sdk/v8/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
* }
* sccV2FolderNotificationConfig, err := pubsub.NewTopic(ctx, "scc_v2_folder_notification_config", &pubsub.TopicArgs{
* Name: pulumi.String("my-topic"),
* })
* if err != nil {
* return err
* }
* _, err = securitycenter.NewV2FolderNotificationConfig(ctx, "custom_notification_config", &securitycenter.V2FolderNotificationConfigArgs{
* ConfigId: pulumi.String("my-config"),
* Folder: folder.FolderId,
* Location: pulumi.String("global"),
* Description: pulumi.String("My custom Cloud Security Command Center Finding Notification Configuration"),
* PubsubTopic: sccV2FolderNotificationConfig.ID(),
* StreamingConfig: &securitycenter.V2FolderNotificationConfigStreamingConfigArgs{
* Filter: pulumi.String("category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\""),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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.V2FolderNotificationConfig;
* import com.pulumi.gcp.securitycenter.V2FolderNotificationConfigArgs;
* import com.pulumi.gcp.securitycenter.inputs.V2FolderNotificationConfigStreamingConfigArgs;
* 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 folder = new Folder("folder", FolderArgs.builder()
* .parent("organizations/123456789")
* .displayName("folder-name")
* .build());
* var sccV2FolderNotificationConfig = new Topic("sccV2FolderNotificationConfig", TopicArgs.builder()
* .name("my-topic")
* .build());
* var customNotificationConfig = new V2FolderNotificationConfig("customNotificationConfig", V2FolderNotificationConfigArgs.builder()
* .configId("my-config")
* .folder(folder.folderId())
* .location("global")
* .description("My custom Cloud Security Command Center Finding Notification Configuration")
* .pubsubTopic(sccV2FolderNotificationConfig.id())
* .streamingConfig(V2FolderNotificationConfigStreamingConfigArgs.builder()
* .filter("category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* folder:
* type: gcp:organizations:Folder
* properties:
* parent: organizations/123456789
* displayName: folder-name
* sccV2FolderNotificationConfig:
* type: gcp:pubsub:Topic
* name: scc_v2_folder_notification_config
* properties:
* name: my-topic
* customNotificationConfig:
* type: gcp:securitycenter:V2FolderNotificationConfig
* name: custom_notification_config
* properties:
* configId: my-config
* folder: ${folder.folderId}
* location: global
* description: My custom Cloud Security Command Center Finding Notification Configuration
* pubsubTopic: ${sccV2FolderNotificationConfig.id}
* streamingConfig:
* filter: category = "OPEN_FIREWALL" AND state = "ACTIVE"
* ```
*
* ## Import
* FolderNotificationConfig can be imported using any of these accepted formats:
* * `folders/{{folder}}/locations/{{location}}/notificationConfigs/{{config_id}}`
* * `{{folder}}/{{location}}/{{config_id}}`
* When using the `pulumi import` command, FolderNotificationConfig can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:securitycenter/v2FolderNotificationConfig:V2FolderNotificationConfig default folders/{{folder}}/locations/{{location}}/notificationConfigs/{{config_id}}
* ```
* ```sh
* $ pulumi import gcp:securitycenter/v2FolderNotificationConfig:V2FolderNotificationConfig default {{folder}}/{{location}}/{{config_id}}
* ```
* @property configId This must be unique within the organization.
* @property description The description of the notification config (max of 1024 characters).
* @property folder Numerical ID of the parent folder.
* @property location Location ID of the parent organization. If not provided, 'global' will be used as the default location.
* @property pubsubTopic The Pub/Sub topic to send notifications to. Its format is
* "projects/[project_id]/topics/[topic]".
* @property streamingConfig The config for triggering streaming-based notifications.
* Structure is documented below.
*/
public data class V2FolderNotificationConfigArgs(
public val configId: Output? = null,
public val description: Output? = null,
public val folder: Output? = null,
public val location: Output? = null,
public val pubsubTopic: Output? = null,
public val streamingConfig: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.securitycenter.V2FolderNotificationConfigArgs =
com.pulumi.gcp.securitycenter.V2FolderNotificationConfigArgs.builder()
.configId(configId?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.folder(folder?.applyValue({ args0 -> args0 }))
.location(location?.applyValue({ args0 -> args0 }))
.pubsubTopic(pubsubTopic?.applyValue({ args0 -> args0 }))
.streamingConfig(
streamingConfig?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
).build()
}
/**
* Builder for [V2FolderNotificationConfigArgs].
*/
@PulumiTagMarker
public class V2FolderNotificationConfigArgsBuilder internal constructor() {
private var configId: Output? = null
private var description: Output? = null
private var folder: Output? = null
private var location: Output? = null
private var pubsubTopic: Output? = null
private var streamingConfig: Output? = null
/**
* @param value This must be unique within the organization.
*/
@JvmName("jjvdwosnsbhessco")
public suspend fun configId(`value`: Output) {
this.configId = value
}
/**
* @param value The description of the notification config (max of 1024 characters).
*/
@JvmName("kadnhrggrlwbygnh")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value Numerical ID of the parent folder.
*/
@JvmName("qyyxlyixaoltxfiw")
public suspend fun folder(`value`: Output) {
this.folder = value
}
/**
* @param value Location ID of the parent organization. If not provided, 'global' will be used as the default location.
*/
@JvmName("orssslgwmlxrggxj")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value The Pub/Sub topic to send notifications to. Its format is
* "projects/[project_id]/topics/[topic]".
*/
@JvmName("eptynjfmgoqrinqy")
public suspend fun pubsubTopic(`value`: Output) {
this.pubsubTopic = value
}
/**
* @param value The config for triggering streaming-based notifications.
* Structure is documented below.
*/
@JvmName("waafrnxcueghbahb")
public suspend fun streamingConfig(`value`: Output) {
this.streamingConfig = value
}
/**
* @param value This must be unique within the organization.
*/
@JvmName("csyfwlrvrsciwwoi")
public suspend fun configId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.configId = mapped
}
/**
* @param value The description of the notification config (max of 1024 characters).
*/
@JvmName("kegsfiyglawsaond")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value Numerical ID of the parent folder.
*/
@JvmName("mnbtqurqebhqkcvl")
public suspend fun folder(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.folder = mapped
}
/**
* @param value Location ID of the parent organization. If not provided, 'global' will be used as the default location.
*/
@JvmName("cgstutdcmdthbosu")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value The Pub/Sub topic to send notifications to. Its format is
* "projects/[project_id]/topics/[topic]".
*/
@JvmName("eoelpdsninkhehli")
public suspend fun pubsubTopic(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.pubsubTopic = mapped
}
/**
* @param value The config for triggering streaming-based notifications.
* Structure is documented below.
*/
@JvmName("ogvadlpewcqolyey")
public suspend fun streamingConfig(`value`: V2FolderNotificationConfigStreamingConfigArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.streamingConfig = mapped
}
/**
* @param argument The config for triggering streaming-based notifications.
* Structure is documented below.
*/
@JvmName("ueoomjdniwouhisl")
public suspend fun streamingConfig(argument: suspend V2FolderNotificationConfigStreamingConfigArgsBuilder.() -> Unit) {
val toBeMapped = V2FolderNotificationConfigStreamingConfigArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.streamingConfig = mapped
}
internal fun build(): V2FolderNotificationConfigArgs = V2FolderNotificationConfigArgs(
configId = configId,
description = description,
folder = folder,
location = location,
pubsubTopic = pubsubTopic,
streamingConfig = streamingConfig,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy