com.pulumi.gcp.securitycenter.kotlin.MuteConfig.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.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 [MuteConfig].
*/
@PulumiTagMarker
public class MuteConfigResourceBuilder internal constructor() {
public var name: String? = null
public var args: MuteConfigArgs = MuteConfigArgs()
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 MuteConfigArgsBuilder.() -> Unit) {
val builder = MuteConfigArgsBuilder()
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(): MuteConfig {
val builtJavaResource = com.pulumi.gcp.securitycenter.MuteConfig(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return MuteConfig(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 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}}
* ```
*/
public class MuteConfig internal constructor(
override val javaResource: com.pulumi.gcp.securitycenter.MuteConfig,
) : KotlinCustomResource(javaResource, MuteConfigMapper) {
/**
* 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 })
/**
* 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}/muteConfigs/{configId},
* folders/{folder}/muteConfigs/{configId},
* or projects/{project}/muteConfigs/{configId}
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Resource name of the new mute configs's parent. Its format is
* "organizations/[organization_id]", "folders/[folder_id]", or
* "projects/[project_id]".
* - - -
*/
public val parent: Output
get() = javaResource.parent().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 MuteConfigMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.securitycenter.MuteConfig::class == javaResource::class
override fun map(javaResource: Resource): MuteConfig = MuteConfig(
javaResource as
com.pulumi.gcp.securitycenter.MuteConfig,
)
}
/**
* @see [MuteConfig].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [MuteConfig].
*/
public suspend fun muteConfig(name: String, block: suspend MuteConfigResourceBuilder.() -> Unit): MuteConfig {
val builder = MuteConfigResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [MuteConfig].
* @param name The _unique_ name of the resulting resource.
*/
public fun muteConfig(name: String): MuteConfig {
val builder = MuteConfigResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy