com.pulumi.gcp.securitycenter.kotlin.NotificationConfig.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.securitycenter.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.securitycenter.kotlin.outputs.NotificationConfigStreamingConfig
import com.pulumi.gcp.securitycenter.kotlin.outputs.NotificationConfigStreamingConfig.Companion.toKotlin
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
/**
* Builder for [NotificationConfig].
*/
@PulumiTagMarker
public class NotificationConfigResourceBuilder internal constructor() {
public var name: String? = null
public var args: NotificationConfigArgs = NotificationConfigArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend NotificationConfigArgsBuilder.() -> Unit) {
val builder = NotificationConfigArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): NotificationConfig {
val builtJavaResource =
com.pulumi.gcp.securitycenter.NotificationConfig(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return NotificationConfig(builtJavaResource)
}
}
/**
* 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 NotificationConfig, see:
* * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/organizations.notificationConfigs)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/security-command-center/docs)
* ## Example Usage
* ### Scc Notification Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* const sccNotification = new gcp.pubsub.Topic("scc_notification", {name: "my-topic"});
* const customNotificationConfig = new gcp.securitycenter.NotificationConfig("custom_notification_config", {
* configId: "my-config",
* organization: "123456789",
* description: "My custom Cloud Security Command Center Finding Notification Configuration",
* pubsubTopic: sccNotification.id,
* streamingConfig: {
* filter: "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* scc_notification = gcp.pubsub.Topic("scc_notification", name="my-topic")
* custom_notification_config = gcp.securitycenter.NotificationConfig("custom_notification_config",
* config_id="my-config",
* organization="123456789",
* description="My custom Cloud Security Command Center Finding Notification Configuration",
* pubsub_topic=scc_notification.id,
* streaming_config=gcp.securitycenter.NotificationConfigStreamingConfigArgs(
* 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 sccNotification = new Gcp.PubSub.Topic("scc_notification", new()
* {
* Name = "my-topic",
* });
* var customNotificationConfig = new Gcp.SecurityCenter.NotificationConfig("custom_notification_config", new()
* {
* ConfigId = "my-config",
* Organization = "123456789",
* Description = "My custom Cloud Security Command Center Finding Notification Configuration",
* PubsubTopic = sccNotification.Id,
* StreamingConfig = new Gcp.SecurityCenter.Inputs.NotificationConfigStreamingConfigArgs
* {
* Filter = "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/pubsub"
* "github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/securitycenter"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* sccNotification, err := pubsub.NewTopic(ctx, "scc_notification", &pubsub.TopicArgs{
* Name: pulumi.String("my-topic"),
* })
* if err != nil {
* return err
* }
* _, err = securitycenter.NewNotificationConfig(ctx, "custom_notification_config", &securitycenter.NotificationConfigArgs{
* ConfigId: pulumi.String("my-config"),
* Organization: pulumi.String("123456789"),
* Description: pulumi.String("My custom Cloud Security Command Center Finding Notification Configuration"),
* PubsubTopic: sccNotification.ID(),
* StreamingConfig: &securitycenter.NotificationConfigStreamingConfigArgs{
* 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.pubsub.Topic;
* import com.pulumi.gcp.pubsub.TopicArgs;
* import com.pulumi.gcp.securitycenter.NotificationConfig;
* import com.pulumi.gcp.securitycenter.NotificationConfigArgs;
* import com.pulumi.gcp.securitycenter.inputs.NotificationConfigStreamingConfigArgs;
* 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 sccNotification = new Topic("sccNotification", TopicArgs.builder()
* .name("my-topic")
* .build());
* var customNotificationConfig = new NotificationConfig("customNotificationConfig", NotificationConfigArgs.builder()
* .configId("my-config")
* .organization("123456789")
* .description("My custom Cloud Security Command Center Finding Notification Configuration")
* .pubsubTopic(sccNotification.id())
* .streamingConfig(NotificationConfigStreamingConfigArgs.builder()
* .filter("category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* sccNotification:
* type: gcp:pubsub:Topic
* name: scc_notification
* properties:
* name: my-topic
* customNotificationConfig:
* type: gcp:securitycenter:NotificationConfig
* name: custom_notification_config
* properties:
* configId: my-config
* organization: '123456789'
* description: My custom Cloud Security Command Center Finding Notification Configuration
* pubsubTopic: ${sccNotification.id}
* streamingConfig:
* filter: category = "OPEN_FIREWALL" AND state = "ACTIVE"
* ```
*
* ## Import
* NotificationConfig can be imported using any of these accepted formats:
* * `organizations/{{organization}}/notificationConfigs/{{name}}`
* * `{{organization}}/{{name}}`
* When using the `pulumi import` command, NotificationConfig can be imported using one of the formats above. For example:
* ```sh
* $ pulumi import gcp:securitycenter/notificationConfig:NotificationConfig default organizations/{{organization}}/notificationConfigs/{{name}}
* ```
* ```sh
* $ pulumi import gcp:securitycenter/notificationConfig:NotificationConfig default {{organization}}/{{name}}
* ```
*/
public class NotificationConfig internal constructor(
override val javaResource: com.pulumi.gcp.securitycenter.NotificationConfig,
) : KotlinCustomResource(javaResource, NotificationConfigMapper) {
/**
* This must be unique within the organization.
*/
public val configId: Output
get() = javaResource.configId().applyValue({ args0 -> args0 })
/**
* The description of the notification config (max of 1024 characters).
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The resource name of this notification config, in the format
* `organizations/{{organization}}/notificationConfigs/{{config_id}}`.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The organization whose Cloud Security Command Center the Notification
* Config lives in.
*/
public val organization: Output
get() = javaResource.organization().applyValue({ args0 -> args0 })
/**
* The Pub/Sub topic to send notifications to. Its format is
* "projects/[project_id]/topics/[topic]".
*/
public val pubsubTopic: Output
get() = javaResource.pubsubTopic().applyValue({ args0 -> args0 })
/**
* The service account that needs "pubsub.topics.publish" permission to
* publish to the Pub/Sub topic.
*/
public val serviceAccount: Output
get() = javaResource.serviceAccount().applyValue({ args0 -> args0 })
/**
* The config for triggering streaming-based notifications.
* Structure is documented below.
*/
public val streamingConfig: Output
get() = javaResource.streamingConfig().applyValue({ args0 ->
args0.let({ args0 ->
toKotlin(args0)
})
})
}
public object NotificationConfigMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.securitycenter.NotificationConfig::class == javaResource::class
override fun map(javaResource: Resource): NotificationConfig = NotificationConfig(
javaResource as
com.pulumi.gcp.securitycenter.NotificationConfig,
)
}
/**
* @see [NotificationConfig].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [NotificationConfig].
*/
public suspend fun notificationConfig(
name: String,
block: suspend NotificationConfigResourceBuilder.() -> Unit,
): NotificationConfig {
val builder = NotificationConfigResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [NotificationConfig].
* @param name The _unique_ name of the resulting resource.
*/
public fun notificationConfig(name: String): NotificationConfig {
val builder = NotificationConfigResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy