Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. securitycenter
  5. MuteConfig
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.securitycenter.MuteConfig

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

    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:

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

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

    package main

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

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

});

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

    }
}

    resources:
  default:
    type: gcp:securitycenter:MuteConfig
    properties:
      muteConfigId: my-config
      parent: organizations/123456789
      filter: 'category: "OS_VULNERABILITY"'
      description: My Mute Config

    Create MuteConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MuteConfig(name: string, args: MuteConfigArgs, opts?: CustomResourceOptions);
    @overload
def MuteConfig(resource_name: str,
               args: MuteConfigArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def MuteConfig(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               filter: Optional[str] = None,
               mute_config_id: Optional[str] = None,
               parent: Optional[str] = None,
               description: Optional[str] = None)
    func NewMuteConfig(ctx *Context, name string, args MuteConfigArgs, opts ...ResourceOption) (*MuteConfig, error)
    public MuteConfig(string name, MuteConfigArgs args, CustomResourceOptions? opts = null)
    public MuteConfig(String name, MuteConfigArgs args)
public MuteConfig(String name, MuteConfigArgs args, CustomResourceOptions options)

    type: gcp:securitycenter:MuteConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MuteConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MuteConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MuteConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MuteConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MuteConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var muteConfigResource = new Gcp.SecurityCenter.MuteConfig("muteConfigResource", new()
{
    Filter = "string",
    MuteConfigId = "string",
    Parent = "string",
    Description = "string",
});

    example, err := securitycenter.NewMuteConfig(ctx, "muteConfigResource", &securitycenter.MuteConfigArgs{
	Filter:       pulumi.String("string"),
	MuteConfigId: pulumi.String("string"),
	Parent:       pulumi.String("string"),
	Description:  pulumi.String("string"),
})

    var muteConfigResource = new MuteConfig("muteConfigResource", MuteConfigArgs.builder()
    .filter("string")
    .muteConfigId("string")
    .parent("string")
    .description("string")
    .build());

    mute_config_resource = gcp.securitycenter.MuteConfig("muteConfigResource",
    filter="string",
    mute_config_id="string",
    parent="string",
    description="string")

    const muteConfigResource = new gcp.securitycenter.MuteConfig("muteConfigResource", {
    filter: "string",
    muteConfigId: "string",
    parent: "string",
    description: "string",
});

    type: gcp:securitycenter:MuteConfig
properties:
    description: string
    filter: string
    muteConfigId: string
    parent: string

    MuteConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The MuteConfig resource accepts the following input properties:

    Filter 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.
    MuteConfigId string
    Unique identifier provided by the client within the parent scope.
    Parent string
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    Description string
    A description of the mute config.
    Filter 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.
    MuteConfigId string
    Unique identifier provided by the client within the parent scope.
    Parent string
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    Description string
    A description of the mute config.
    filter 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.
    muteConfigId String
    Unique identifier provided by the client within the parent scope.
    parent String
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    description String
    A description of the mute config.
    filter 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.
    muteConfigId string
    Unique identifier provided by the client within the parent scope.
    parent string
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    description string
    A description of the mute config.
    filter str
    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.
    mute_config_id str
    Unique identifier provided by the client within the parent scope.
    parent str
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    description str
    A description of the mute config.
    filter 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.
    muteConfigId String
    Unique identifier provided by the client within the parent scope.
    parent String
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    description String
    A description of the mute config.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the MuteConfig resource produces the following output properties:

    CreateTime 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    MostRecentEditor 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.
    Name string
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    UpdateTime 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.
    CreateTime 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    MostRecentEditor 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.
    Name string
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    UpdateTime 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.
    createTime 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.
    id String
    The provider-assigned unique ID for this managed resource.
    mostRecentEditor 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.
    name String
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    updateTime 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.
    createTime 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.
    id string
    The provider-assigned unique ID for this managed resource.
    mostRecentEditor 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.
    name string
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    updateTime 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.
    create_time str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    most_recent_editor str
    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.
    name str
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    update_time str
    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.
    createTime 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.
    id String
    The provider-assigned unique ID for this managed resource.
    mostRecentEditor 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.
    name String
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    updateTime 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.

    Look up Existing MuteConfig Resource

    Get an existing MuteConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MuteConfigState, opts?: CustomResourceOptions): MuteConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        filter: Optional[str] = None,
        most_recent_editor: Optional[str] = None,
        mute_config_id: Optional[str] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None,
        update_time: Optional[str] = None) -> MuteConfig
    func GetMuteConfig(ctx *Context, name string, id IDInput, state *MuteConfigState, opts ...ResourceOption) (*MuteConfig, error)
    public static MuteConfig Get(string name, Input<string> id, MuteConfigState? state, CustomResourceOptions? opts = null)
    public static MuteConfig get(String name, Output<String> id, MuteConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreateTime 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.
    Description string
    A description of the mute config.
    Filter 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.
    MostRecentEditor 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.
    MuteConfigId string
    Unique identifier provided by the client within the parent scope.
    Name string
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    Parent string
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    UpdateTime 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.
    CreateTime 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.
    Description string
    A description of the mute config.
    Filter 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.
    MostRecentEditor 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.
    MuteConfigId string
    Unique identifier provided by the client within the parent scope.
    Name string
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    Parent string
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    UpdateTime 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.
    createTime 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.
    description String
    A description of the mute config.
    filter 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.
    mostRecentEditor 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.
    muteConfigId String
    Unique identifier provided by the client within the parent scope.
    name String
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    parent String
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    updateTime 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.
    createTime 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.
    description string
    A description of the mute config.
    filter 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.
    mostRecentEditor 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.
    muteConfigId string
    Unique identifier provided by the client within the parent scope.
    name string
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    parent string
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    updateTime 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.
    create_time str
    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.
    description str
    A description of the mute config.
    filter str
    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.
    most_recent_editor str
    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.
    mute_config_id str
    Unique identifier provided by the client within the parent scope.
    name str
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    parent str
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    update_time str
    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.
    createTime 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.
    description String
    A description of the mute config.
    filter 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.
    mostRecentEditor 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.
    muteConfigId String
    Unique identifier provided by the client within the parent scope.
    name String
    Name of the mute config. Its format is organizations/{organization}/muteConfigs/{configId}, folders/{folder}/muteConfigs/{configId}, or projects/{project}/muteConfigs/{configId}
    parent String
    Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]".

    updateTime 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.

    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}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-gcp