All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.gcp.securitycenter.kotlin.V2FolderMuteConfig.kt Maven / Gradle / Ivy

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.securitycenter.kotlin

import com.pulumi.core.Output
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 [V2FolderMuteConfig].
 */
@PulumiTagMarker
public class V2FolderMuteConfigResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: V2FolderMuteConfigArgs = V2FolderMuteConfigArgs()

    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 V2FolderMuteConfigArgsBuilder.() -> Unit) {
        val builder = V2FolderMuteConfigArgsBuilder()
        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(): V2FolderMuteConfig {
        val builtJavaResource =
            com.pulumi.gcp.securitycenter.V2FolderMuteConfig(
                this.name,
                this.args.toJava(),
                this.opts.toJava(),
            )
        return V2FolderMuteConfig(builtJavaResource)
    }
}

/**
 * Mute Findings is a volume management feature in Security Command Center
 * that lets you manually or programmatically hide irrelevant findings,
 * and create filters to automatically silence existing and future
 * findings based on criteria you specify.
 * To get more information about FolderMuteConfig, see:
 * * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v2/folders.muteConfigs)
 * ## Example Usage
 * ### Scc V2 Folder Mute 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 _default = new gcp.securitycenter.V2FolderMuteConfig("default", {
 *     muteConfigId: "my-config",
 *     folder: folder.folderId,
 *     location: "global",
 *     description: "My custom Cloud Security Command Center Finding Folder mute Configuration",
 *     filter: "severity = \"HIGH\"",
 *     type: "STATIC",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * folder = gcp.organizations.Folder("folder",
 *     parent="organizations/123456789",
 *     display_name="folder-name")
 * default = gcp.securitycenter.V2FolderMuteConfig("default",
 *     mute_config_id="my-config",
 *     folder=folder.folder_id,
 *     location="global",
 *     description="My custom Cloud Security Command Center Finding Folder mute Configuration",
 *     filter="severity = \"HIGH\"",
 *     type="STATIC")
 * ```
 * ```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 @default = new Gcp.SecurityCenter.V2FolderMuteConfig("default", new()
 *     {
 *         MuteConfigId = "my-config",
 *         Folder = folder.FolderId,
 *         Location = "global",
 *         Description = "My custom Cloud Security Command Center Finding Folder mute Configuration",
 *         Filter = "severity = \"HIGH\"",
 *         Type = "STATIC",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
 * 	"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 {
 * 		folder, err := organizations.NewFolder(ctx, "folder", &organizations.FolderArgs{
 * 			Parent:      pulumi.String("organizations/123456789"),
 * 			DisplayName: pulumi.String("folder-name"),
 * 		})
 * 		if err != nil {
 * 			return err
 * 		}
 * 		_, err = securitycenter.NewV2FolderMuteConfig(ctx, "default", &securitycenter.V2FolderMuteConfigArgs{
 * 			MuteConfigId: pulumi.String("my-config"),
 * 			Folder:       folder.FolderId,
 * 			Location:     pulumi.String("global"),
 * 			Description:  pulumi.String("My custom Cloud Security Command Center Finding Folder mute Configuration"),
 * 			Filter:       pulumi.String("severity = \"HIGH\""),
 * 			Type:         pulumi.String("STATIC"),
 * 		})
 * 		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.securitycenter.V2FolderMuteConfig;
 * import com.pulumi.gcp.securitycenter.V2FolderMuteConfigArgs;
 * 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 default_ = new V2FolderMuteConfig("default", V2FolderMuteConfigArgs.builder()
 *             .muteConfigId("my-config")
 *             .folder(folder.folderId())
 *             .location("global")
 *             .description("My custom Cloud Security Command Center Finding Folder mute Configuration")
 *             .filter("severity = \"HIGH\"")
 *             .type("STATIC")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   folder:
 *     type: gcp:organizations:Folder
 *     properties:
 *       parent: organizations/123456789
 *       displayName: folder-name
 *   default:
 *     type: gcp:securitycenter:V2FolderMuteConfig
 *     properties:
 *       muteConfigId: my-config
 *       folder: ${folder.folderId}
 *       location: global
 *       description: My custom Cloud Security Command Center Finding Folder mute Configuration
 *       filter: severity = "HIGH"
 *       type: STATIC
 * ```
 * 
 * ## Import
 * FolderMuteConfig can be imported using any of these accepted formats:
 * * `folders/{{folder}}/locations/{{location}}/muteConfigs/{{mute_config_id}}`
 * * `{{folder}}/{{location}}/{{mute_config_id}}`
 * When using the `pulumi import` command, FolderMuteConfig can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:securitycenter/v2FolderMuteConfig:V2FolderMuteConfig default folders/{{folder}}/locations/{{location}}/muteConfigs/{{mute_config_id}}
 * ```
 * ```sh
 * $ pulumi import gcp:securitycenter/v2FolderMuteConfig:V2FolderMuteConfig default {{folder}}/{{location}}/{{mute_config_id}}
 * ```
 */
public class V2FolderMuteConfig internal constructor(
    override val javaResource: com.pulumi.gcp.securitycenter.V2FolderMuteConfig,
) : KotlinCustomResource(javaResource, V2FolderMuteConfigMapper) {
    /**
     * The time at which the mute config was created. This field is set by
     * the server and will be ignored if provided on config creation.
     */
    public val createTime: Output
        get() = javaResource.createTime().applyValue({ args0 -> args0 })

    /**
     * A description of the mute config.
     */
    public val description: Output?
        get() = javaResource.description().applyValue({ args0 ->
            args0.map({ args0 ->
                args0
            }).orElse(null)
        })

    /**
     * An expression that defines the filter to apply across create/update
     * events of findings. While creating a filter string, be mindful of
     * the scope in which the mute configuration is being created. E.g.,
     * If a filter contains project = X but is created under the
     * project = Y scope, it might not match any findings.
     */
    public val filter: Output
        get() = javaResource.filter().applyValue({ args0 -> args0 })

    /**
     * The folder whose Cloud Security Command Center the Mute
     * Config lives in.
     */
    public val folder: Output
        get() = javaResource.folder().applyValue({ args0 -> args0 })

    /**
     * location Id is provided by folder. If not provided, Use global as default.
     */
    public val location: Output?
        get() = javaResource.location().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * Email address of the user who last edited the mute config. This
     * field is set by the server and will be ignored if provided on
     * config creation or update.
     */
    public val mostRecentEditor: Output
        get() = javaResource.mostRecentEditor().applyValue({ args0 -> args0 })

    /**
     * Unique identifier provided by the client within the parent scope.
     * - - -
     */
    public val muteConfigId: Output
        get() = javaResource.muteConfigId().applyValue({ args0 -> args0 })

    /**
     * Name of the mute config. Its format is
     * organizations/{organization}/locations/global/muteConfigs/{configId},
     * folders/{folder}/locations/global/muteConfigs/{configId},
     * or projects/{project}/locations/global/muteConfigs/{configId}
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The type of the mute config.
     */
    public val type: Output
        get() = javaResource.type().applyValue({ args0 -> args0 })

    /**
     * Output only. The most recent time at which the mute config was
     * updated. This field is set by the server and will be ignored if
     * provided on config creation or update.
     */
    public val updateTime: Output
        get() = javaResource.updateTime().applyValue({ args0 -> args0 })
}

public object V2FolderMuteConfigMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.gcp.securitycenter.V2FolderMuteConfig::class == javaResource::class

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

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

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




© 2015 - 2024 Weber Informatics LLC | Privacy Policy