@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
231 lines (230 loc) • 8.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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](https://cloud.google.com/security-command-center/docs/reference/rest/v2/folders.muteConfigs)
*
* ## Example Usage
*
* ### Scc V2 Folder Mute Config Basic
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ pulumi import gcp:securitycenter/v2FolderMuteConfig:V2FolderMuteConfig default folders/{{folder}}/locations/{{location}}/muteConfigs/{{mute_config_id}}
* ```
*
* ```sh
* $ pulumi import gcp:securitycenter/v2FolderMuteConfig:V2FolderMuteConfig default {{folder}}/{{location}}/{{mute_config_id}}
* ```
*/
export declare class V2FolderMuteConfig extends pulumi.CustomResource {
/**
* Get an existing V2FolderMuteConfig resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: V2FolderMuteConfigState, opts?: pulumi.CustomResourceOptions): V2FolderMuteConfig;
/**
* Returns true if the given object is an instance of V2FolderMuteConfig. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is V2FolderMuteConfig;
/**
* 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.
*/
readonly createTime: pulumi.Output<string>;
/**
* A description of the mute config.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly filter: pulumi.Output<string>;
/**
* The folder whose Cloud Security Command Center the Mute
* Config lives in.
*/
readonly folder: pulumi.Output<string>;
/**
* location Id is provided by folder. If not provided, Use global as default.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* 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.
*/
readonly mostRecentEditor: pulumi.Output<string>;
/**
* Unique identifier provided by the client within the parent scope.
*
*
* - - -
*/
readonly muteConfigId: pulumi.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}
*/
readonly name: pulumi.Output<string>;
/**
* The type of the mute config.
*/
readonly type: pulumi.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.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a V2FolderMuteConfig resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: V2FolderMuteConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering V2FolderMuteConfig resources.
*/
export interface V2FolderMuteConfigState {
/**
* 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.
*/
createTime?: pulumi.Input<string>;
/**
* A description of the mute config.
*/
description?: pulumi.Input<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.
*/
filter?: pulumi.Input<string>;
/**
* The folder whose Cloud Security Command Center the Mute
* Config lives in.
*/
folder?: pulumi.Input<string>;
/**
* location Id is provided by folder. If not provided, Use global as default.
*/
location?: pulumi.Input<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.
*/
mostRecentEditor?: pulumi.Input<string>;
/**
* Unique identifier provided by the client within the parent scope.
*
*
* - - -
*/
muteConfigId?: pulumi.Input<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}
*/
name?: pulumi.Input<string>;
/**
* The type of the mute config.
*/
type?: pulumi.Input<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.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a V2FolderMuteConfig resource.
*/
export interface V2FolderMuteConfigArgs {
/**
* A description of the mute config.
*/
description?: pulumi.Input<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.
*/
filter: pulumi.Input<string>;
/**
* The folder whose Cloud Security Command Center the Mute
* Config lives in.
*/
folder: pulumi.Input<string>;
/**
* location Id is provided by folder. If not provided, Use global as default.
*/
location?: pulumi.Input<string>;
/**
* Unique identifier provided by the client within the parent scope.
*
*
* - - -
*/
muteConfigId: pulumi.Input<string>;
/**
* The type of the mute config.
*/
type: pulumi.Input<string>;
}