MuteConfig class

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

Example Usage

Scc Mute Config

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",
    type: "DYNAMIC",
    expiryTime: "2215-02-03T15:01:23Z",
});

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",
    type="DYNAMIC",
    expiry_time="2215-02-03T15:01:23Z")

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",
        Type = "DYNAMIC",
        ExpiryTime = "2215-02-03T15:01:23Z",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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"),
			Type:         pulumi.String("DYNAMIC"),
			ExpiryTime:   pulumi.String("2215-02-03T15:01:23Z"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_securitycenter_muteconfig" "default" {
  mute_config_id = "my-config"
  parent         = "organizations/123456789"
  filter         = "category: \"OS_VULNERABILITY\""
  description    = "My Mute Config"
  type           = "DYNAMIC"
  expiry_time    = "2215-02-03T15:01:23Z"
}

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.ArrayList;
import java.util.Arrays;
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")
            .type("DYNAMIC")
            .expiryTime("2215-02-03T15:01:23Z")
            .build());

    }
}

resources:
  default:
    type: gcp:securitycenter:MuteConfig
    properties:
      muteConfigId: my-config
      parent: organizations/123456789
      filter: 'category: "OS_VULNERABILITY"'
      description: My Mute Config
      type: DYNAMIC
      expiryTime: 2215-02-03T15:01:23Z

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:

$ pulumi import gcp:securitycenter/muteConfig:MuteConfig default {{name}}

Constructors

MuteConfig(String name, {MuteConfigArgs? args, CustomResourceOptions? options})

Creates a new MuteConfig. name The Pulumi resource name. args Arguments used to configure this MuteConfig. The set of arguments for MuteConfig. options Resource options controlling this resource's behavior.

MuteConfig.reference(String urn)

Creates a typed reference to an existing MuteConfig resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

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.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

A description of the mute config.

late, final

expiryTime ↔ Output<String?>

Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

late, final

filter ↔ Output<String>

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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

mostRecentEditor ↔ Output<String>

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.

late, final

muteConfigId ↔ Output<String>

Unique identifier provided by the client within the parent scope.

late, final

name ↔ Output<String>

Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}

late, final

parent ↔ Output<String>

Resource name of the new mute configs's parent. Its format is "organizations/organizationId", "folders/folderId", or "projects/projectId".

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String?>

The type of the mute config, which determines what type of mute state the config affects. Default value is DYNAMIC. Possible values are: MUTE_CONFIG_TYPE_UNSPECIFIED, STATIC, DYNAMIC.

late, final

updateTime ↔ Output<String>

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.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {MuteConfigState? state, CustomResourceOptions? options}) → MuteConfig

Gets an existing MuteConfig resource's state with the given name and id.