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

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

Go to download

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.10.0.0
Show newest version
@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.MuteConfigArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * 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 MuteConfig, see:
 * * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/organizations.muteConfigs)
 * ## Example Usage
 * ### Scc Mute Config
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 * const _default = new gcp.securitycenter.MuteConfig("default", {
 *     muteConfigId: "my-config",
 *     parent: "organizations/123456789",
 *     filter: "category: \"OS_VULNERABILITY\"",
 *     description: "My Mute Config",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * default = gcp.securitycenter.MuteConfig("default",
 *     mute_config_id="my-config",
 *     parent="organizations/123456789",
 *     filter="category: \"OS_VULNERABILITY\"",
 *     description="My Mute Config")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Gcp = Pulumi.Gcp;
 * return await Deployment.RunAsync(() =>
 * {
 *     var @default = new Gcp.SecurityCenter.MuteConfig("default", new()
 *     {
 *         MuteConfigId = "my-config",
 *         Parent = "organizations/123456789",
 *         Filter = "category: \"OS_VULNERABILITY\"",
 *         Description = "My Mute Config",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"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 {
 * 		_, err := securitycenter.NewMuteConfig(ctx, "default", &securitycenter.MuteConfigArgs{
 * 			MuteConfigId: pulumi.String("my-config"),
 * 			Parent:       pulumi.String("organizations/123456789"),
 * 			Filter:       pulumi.String("category: \"OS_VULNERABILITY\""),
 * 			Description:  pulumi.String("My Mute Config"),
 * 		})
 * 		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.securitycenter.MuteConfig;
 * import com.pulumi.gcp.securitycenter.MuteConfigArgs;
 * 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 default_ = new MuteConfig("default", MuteConfigArgs.builder()
 *             .muteConfigId("my-config")
 *             .parent("organizations/123456789")
 *             .filter("category: \"OS_VULNERABILITY\"")
 *             .description("My Mute Config")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   default:
 *     type: gcp:securitycenter:MuteConfig
 *     properties:
 *       muteConfigId: my-config
 *       parent: organizations/123456789
 *       filter: 'category: "OS_VULNERABILITY"'
 *       description: My Mute Config
 * ```
 * 
 * ## Import
 * MuteConfig can be imported using any of these accepted formats:
 * * `{{name}}`
 * When using the `pulumi import` command, MuteConfig can be imported using one of the formats above. For example:
 * ```sh
 * $ pulumi import gcp:securitycenter/muteConfig:MuteConfig default {{name}}
 * ```
 * @property description A description of the mute config.
 * @property filter 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.
 * @property muteConfigId Unique identifier provided by the client within the parent scope.
 * @property parent Resource name of the new mute configs's parent. Its format is
 * "organizations/[organization_id]", "folders/[folder_id]", or
 * "projects/[project_id]".
 * - - -
 */
public data class MuteConfigArgs(
    public val description: Output? = null,
    public val filter: Output? = null,
    public val muteConfigId: Output? = null,
    public val parent: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.securitycenter.MuteConfigArgs =
        com.pulumi.gcp.securitycenter.MuteConfigArgs.builder()
            .description(description?.applyValue({ args0 -> args0 }))
            .filter(filter?.applyValue({ args0 -> args0 }))
            .muteConfigId(muteConfigId?.applyValue({ args0 -> args0 }))
            .parent(parent?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [MuteConfigArgs].
 */
@PulumiTagMarker
public class MuteConfigArgsBuilder internal constructor() {
    private var description: Output? = null

    private var filter: Output? = null

    private var muteConfigId: Output? = null

    private var parent: Output? = null

    /**
     * @param value A description of the mute config.
     */
    @JvmName("ufpmmauckmhlxgyv")
    public suspend fun description(`value`: Output) {
        this.description = value
    }

    /**
     * @param value 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.
     */
    @JvmName("uvvlscwjxagdqemo")
    public suspend fun filter(`value`: Output) {
        this.filter = value
    }

    /**
     * @param value Unique identifier provided by the client within the parent scope.
     */
    @JvmName("cdevojwrmjxhglci")
    public suspend fun muteConfigId(`value`: Output) {
        this.muteConfigId = value
    }

    /**
     * @param value Resource name of the new mute configs's parent. Its format is
     * "organizations/[organization_id]", "folders/[folder_id]", or
     * "projects/[project_id]".
     * - - -
     */
    @JvmName("erklancrpimcpiex")
    public suspend fun parent(`value`: Output) {
        this.parent = value
    }

    /**
     * @param value A description of the mute config.
     */
    @JvmName("jjblnyrdwmpnacei")
    public suspend fun description(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.description = mapped
    }

    /**
     * @param value 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.
     */
    @JvmName("edwutrytsmiclmln")
    public suspend fun filter(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.filter = mapped
    }

    /**
     * @param value Unique identifier provided by the client within the parent scope.
     */
    @JvmName("wfbnjlfvndoigfoe")
    public suspend fun muteConfigId(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.muteConfigId = mapped
    }

    /**
     * @param value Resource name of the new mute configs's parent. Its format is
     * "organizations/[organization_id]", "folders/[folder_id]", or
     * "projects/[project_id]".
     * - - -
     */
    @JvmName("yrohmkpiegdyihrh")
    public suspend fun parent(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.parent = mapped
    }

    internal fun build(): MuteConfigArgs = MuteConfigArgs(
        description = description,
        filter = filter,
        muteConfigId = muteConfigId,
        parent = parent,
    )
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy