com.pulumi.gcp.securitycenter.kotlin.FolderNotificationConfig.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.20.1.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.securitycenter.kotlin

import com.pulumi.core.Output
import com.pulumi.gcp.securitycenter.kotlin.outputs.FolderNotificationConfigStreamingConfig
import com.pulumi.gcp.securitycenter.kotlin.outputs.FolderNotificationConfigStreamingConfig.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 [FolderNotificationConfig].
 */
@PulumiTagMarker
public class FolderNotificationConfigResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: FolderNotificationConfigArgs = FolderNotificationConfigArgs()

    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 FolderNotificationConfigArgsBuilder.() -> Unit) {
        val builder = FolderNotificationConfigArgsBuilder()
        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(): FolderNotificationConfig {
        val builtJavaResource =
            com.pulumi.gcp.securitycenter.FolderNotificationConfig(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return FolderNotificationConfig(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 FolderNotificationConfig, see:
 * * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/folders.notificationConfigs)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/security-command-center/docs)
 * ## Example Usage
 * ### Scc Folder Notification Config Basic
 * 
 * ```yaml
 * 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:
 * ```sh
 * $ pulumi import gcp:securitycenter/folderNotificationConfig:FolderNotificationConfig default folders/{{folder}}/notificationConfigs/{{config_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:securitycenter/folderNotificationConfig:FolderNotificationConfig default {{folder}}/{{config_id}}
 * ```
 */
public class FolderNotificationConfig internal constructor(
    override val javaResource: com.pulumi.gcp.securitycenter.FolderNotificationConfig,
) : KotlinCustomResource(javaResource, FolderNotificationConfigMapper) {
    /**
     * 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)
        })

    /**
     * Numerical ID of the parent folder.
     */
    public val folder: Output
        get() = javaResource.folder().applyValue({ args0 -> args0 })

    /**
     * The resource name of this notification config, in the format
     * `folders/{{folder}}/notificationConfigs/{{config_id}}`.
     */
    public val name: Output
        get() = javaResource.name().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 FolderNotificationConfigMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.securitycenter.FolderNotificationConfig::class == javaResource::class

    override fun map(javaResource: Resource): FolderNotificationConfig =
        FolderNotificationConfig(
            javaResource as
                com.pulumi.gcp.securitycenter.FolderNotificationConfig,
        )
}

/**
 * @see [FolderNotificationConfig].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [FolderNotificationConfig].
 */
public suspend fun folderNotificationConfig(
    name: String,
    block: suspend FolderNotificationConfigResourceBuilder.() -> Unit,
): FolderNotificationConfig {
    val builder = FolderNotificationConfigResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [FolderNotificationConfig].
 * @param name The _unique_ name of the resulting resource.
 */
public fun folderNotificationConfig(name: String): FolderNotificationConfig {
    val builder = FolderNotificationConfigResourceBuilder()
    builder.name(name)
    return builder.build()
}