@pulumi/gcp/securitycenter/v2folderNotificationConfig.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * This is a continuous export that exports findings to a Pub/Sub topic.
 *
 * To get more information about FolderNotificationConfig, see:
 *
 * * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v2/folders.locations.notificationConfigs)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/security-command-center/docs)
 *
 * ## Example Usage
 *
 * ### Scc V2 Folder Notification 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 sccV2FolderNotificationConfig = new gcp.pubsub.Topic("scc_v2_folder_notification_config", {name: "my-topic"});
 * const customNotificationConfig = new gcp.securitycenter.V2FolderNotificationConfig("custom_notification_config", {
 *     configId: "my-config",
 *     folder: folder.folderId,
 *     location: "global",
 *     description: "My custom Cloud Security Command Center Finding Notification Configuration",
 *     pubsubTopic: sccV2FolderNotificationConfig.id,
 *     streamingConfig: {
 *         filter: "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * FolderNotificationConfig can be imported using any of these accepted formats:
 *
 * * `folders/{{folder}}/locations/{{location}}/notificationConfigs/{{config_id}}`
 *
 * * `{{folder}}/{{location}}/{{config_id}}`
 *
 * When using the `pulumi import` command, FolderNotificationConfig can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:securitycenter/v2FolderNotificationConfig:V2FolderNotificationConfig default folders/{{folder}}/locations/{{location}}/notificationConfigs/{{config_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:securitycenter/v2FolderNotificationConfig:V2FolderNotificationConfig default {{folder}}/{{location}}/{{config_id}}
 * ```
 */
export declare class V2FolderNotificationConfig extends pulumi.CustomResource {
    /**
     * Get an existing V2FolderNotificationConfig 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?: V2FolderNotificationConfigState, opts?: pulumi.CustomResourceOptions): V2FolderNotificationConfig;
    /**
     * Returns true if the given object is an instance of V2FolderNotificationConfig.  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 V2FolderNotificationConfig;
    /**
     * This must be unique within the organization.
     */
    readonly configId: pulumi.Output<string>;
    /**
     * The description of the notification config (max of 1024 characters).
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Numerical ID of the parent folder.
     */
    readonly folder: pulumi.Output<string>;
    /**
     * Location ID of the parent organization. If not provided, 'global' will be used as the default location.
     */
    readonly location: pulumi.Output<string | undefined>;
    /**
     * The resource name of this notification config, in the format
     * `folders/{{folder}}/locations/{{location}}/notificationConfigs/{{config_id}}`.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The Pub/Sub topic to send notifications to. Its format is
     * "projects/[projectId]/topics/[topic]".
     */
    readonly pubsubTopic: pulumi.Output<string>;
    /**
     * The service account that needs "pubsub.topics.publish" permission to
     * publish to the Pub/Sub topic.
     */
    readonly serviceAccount: pulumi.Output<string>;
    /**
     * The config for triggering streaming-based notifications.
     * Structure is documented below.
     */
    readonly streamingConfig: pulumi.Output<outputs.securitycenter.V2FolderNotificationConfigStreamingConfig>;
    /**
     * Create a V2FolderNotificationConfig 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: V2FolderNotificationConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering V2FolderNotificationConfig resources.
 */
export interface V2FolderNotificationConfigState {
    /**
     * This must be unique within the organization.
     */
    configId?: pulumi.Input<string>;
    /**
     * The description of the notification config (max of 1024 characters).
     */
    description?: pulumi.Input<string>;
    /**
     * Numerical ID of the parent folder.
     */
    folder?: pulumi.Input<string>;
    /**
     * Location ID of the parent organization. If not provided, 'global' will be used as the default location.
     */
    location?: pulumi.Input<string>;
    /**
     * The resource name of this notification config, in the format
     * `folders/{{folder}}/locations/{{location}}/notificationConfigs/{{config_id}}`.
     */
    name?: pulumi.Input<string>;
    /**
     * The Pub/Sub topic to send notifications to. Its format is
     * "projects/[projectId]/topics/[topic]".
     */
    pubsubTopic?: pulumi.Input<string>;
    /**
     * The service account that needs "pubsub.topics.publish" permission to
     * publish to the Pub/Sub topic.
     */
    serviceAccount?: pulumi.Input<string>;
    /**
     * The config for triggering streaming-based notifications.
     * Structure is documented below.
     */
    streamingConfig?: pulumi.Input<inputs.securitycenter.V2FolderNotificationConfigStreamingConfig>;
}
/**
 * The set of arguments for constructing a V2FolderNotificationConfig resource.
 */
export interface V2FolderNotificationConfigArgs {
    /**
     * This must be unique within the organization.
     */
    configId: pulumi.Input<string>;
    /**
     * The description of the notification config (max of 1024 characters).
     */
    description?: pulumi.Input<string>;
    /**
     * Numerical ID of the parent folder.
     */
    folder: pulumi.Input<string>;
    /**
     * Location ID of the parent organization. If not provided, 'global' will be used as the default location.
     */
    location?: pulumi.Input<string>;
    /**
     * The Pub/Sub topic to send notifications to. Its format is
     * "projects/[projectId]/topics/[topic]".
     */
    pubsubTopic: pulumi.Input<string>;
    /**
     * The config for triggering streaming-based notifications.
     * Structure is documented below.
     */
    streamingConfig: pulumi.Input<inputs.securitycenter.V2FolderNotificationConfigStreamingConfig>;
}