@pulumi/gcp/securitycenter/folderNotificationConfig.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";
/**
 * A Cloud Security Command Center (Cloud SCC) notification configs. A
 * notification config is a Cloud SCC resource that contains the
 * configuration to send notifications for create/update events of
 * findings, assets and etc.
 * > **Note:** In order to use Cloud SCC resources, your organization must be enrolled
 * in [SCC Standard/Premium](https://cloud.google.com/security-command-center/docs/quickstart-security-command-center).
 * Without doing so, you may run into errors during resource creation.
 *
 * To get more information about FolderNotificationConfig, see:
 *
 * * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/folders.notificationConfigs)
 * * How-to Guides
 *     * [Official Documentation](https://cloud.google.com/security-command-center/docs)
 *
 * ## Example Usage
 *
 * ## Import
 *
 * FolderNotificationConfig can be imported using any of these accepted formats:
 *
 * * `folders/{{folder}}/notificationConfigs/{{config_id}}`
 *
 * * `{{folder}}/{{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/folderNotificationConfig:FolderNotificationConfig default folders/{{folder}}/notificationConfigs/{{config_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:securitycenter/folderNotificationConfig:FolderNotificationConfig default {{folder}}/{{config_id}}
 * ```
 */
export declare class FolderNotificationConfig extends pulumi.CustomResource {
    /**
     * Get an existing FolderNotificationConfig 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?: FolderNotificationConfigState, opts?: pulumi.CustomResourceOptions): FolderNotificationConfig;
    /**
     * Returns true if the given object is an instance of FolderNotificationConfig.  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 FolderNotificationConfig;
    /**
     * 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>;
    /**
     * The resource name of this notification config, in the format
     * `folders/{{folder}}/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.FolderNotificationConfigStreamingConfig>;
    /**
     * Create a FolderNotificationConfig 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: FolderNotificationConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FolderNotificationConfig resources.
 */
export interface FolderNotificationConfigState {
    /**
     * 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>;
    /**
     * The resource name of this notification config, in the format
     * `folders/{{folder}}/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.FolderNotificationConfigStreamingConfig>;
}
/**
 * The set of arguments for constructing a FolderNotificationConfig resource.
 */
export interface FolderNotificationConfigArgs {
    /**
     * 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>;
    /**
     * 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.FolderNotificationConfigStreamingConfig>;
}