V2FolderMuteConfig 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 FolderMuteConfig, see:

• API documentation

Example Usage

Scc V2 Folder Mute Config Basic

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",
});

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")

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",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"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 {
		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
	})
}

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

resource "gcp_organizations_folder" "folder" {
  parent       = "organizations/123456789"
  display_name = "folder-name"
}
resource "gcp_securitycenter_v2foldermuteconfig" "default" {
  mute_config_id = "my-config"
  folder         = gcp_organizations_folder.folder.folder_id
  location       = "global"
  description    = "My custom Cloud Security Command Center Finding Folder mute Configuration"
  filter         = "severity = \"HIGH\""
  type           = "STATIC"
}

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.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 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());

    }
}

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:

$ pulumi import gcp:securitycenter/v2FolderMuteConfig:V2FolderMuteConfig default folders/{{folder}}/locations/{{location}}/muteConfigs/{{mute_config_id}}
$ pulumi import gcp:securitycenter/v2FolderMuteConfig:V2FolderMuteConfig default {{folder}}/{{location}}/{{mute_config_id}}

Constructors

V2FolderMuteConfig(String name, {V2FolderMuteConfigArgs? args, CustomResourceOptions? options})

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

V2FolderMuteConfig.reference(String urn)

Creates a typed reference to an existing V2FolderMuteConfig 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

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

folder ↔ Output<String>

The folder whose Cloud Security Command Center the Mute Config lives in.

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

location ↔ Output<String?>

location Id is provided by folder. If not provided, Use global as default.

late, final

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}/locations/global/muteConfigs/{configId}, folders/{folder}/locations/global/muteConfigs/{configId}, or projects/{project}/locations/global/muteConfigs/{configId}

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.

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, {V2FolderMuteConfigState? state, CustomResourceOptions? options}) → V2FolderMuteConfig

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