@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
179 lines (178 loc) • 7.18 kB
TypeScript
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 ProjectNotificationConfig, see:
*
* * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v2/projects.locations.notificationConfigs)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/security-command-center/docs)
*
* ## Example Usage
*
* ### Scc V2 Project Notification Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sccV2ProjectNotification = new gcp.pubsub.Topic("scc_v2_project_notification", {name: "my-topic"});
* const customNotificationConfig = new gcp.securitycenter.V2ProjectNotificationConfig("custom_notification_config", {
* configId: "my-config",
* project: "my-project-name",
* location: "global",
* description: "My custom Cloud Security Command Center Finding Notification Configuration",
* pubsubTopic: sccV2ProjectNotification.id,
* streamingConfig: {
* filter: "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
* },
* });
* ```
*
* ## Import
*
* ProjectNotificationConfig can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/notificationConfigs/{{config_id}}`
*
* * `{{project}}/{{location}}/{{config_id}}`
*
* * `{{location}}/{{config_id}}`
*
* When using the `pulumi import` command, ProjectNotificationConfig can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:securitycenter/v2ProjectNotificationConfig:V2ProjectNotificationConfig default projects/{{project}}/locations/{{location}}/notificationConfigs/{{config_id}}
* ```
*
* ```sh
* $ pulumi import gcp:securitycenter/v2ProjectNotificationConfig:V2ProjectNotificationConfig default {{project}}/{{location}}/{{config_id}}
* ```
*
* ```sh
* $ pulumi import gcp:securitycenter/v2ProjectNotificationConfig:V2ProjectNotificationConfig default {{location}}/{{config_id}}
* ```
*/
export declare class V2ProjectNotificationConfig extends pulumi.CustomResource {
/**
* Get an existing V2ProjectNotificationConfig 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?: V2ProjectNotificationConfigState, opts?: pulumi.CustomResourceOptions): V2ProjectNotificationConfig;
/**
* Returns true if the given object is an instance of V2ProjectNotificationConfig. 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 V2ProjectNotificationConfig;
/**
* This must be unique within the project.
*/
readonly configId: pulumi.Output<string>;
/**
* The description of the notification config (max of 1024 characters).
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Location ID of the parent organization. Only global is supported at the moment.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The resource name of this notification config, in the format
* `projects/{{projectId}}/locations/{{location}}/notificationConfigs/{{config_id}}`.
*/
readonly name: pulumi.Output<string>;
readonly project: pulumi.Output<string>;
/**
* The Pub/Sub topic to send notifications to. Its format is "projects/[projectId]/topics/[topic]".
*/
readonly pubsubTopic: pulumi.Output<string | undefined>;
/**
* 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.V2ProjectNotificationConfigStreamingConfig>;
/**
* Create a V2ProjectNotificationConfig 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: V2ProjectNotificationConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering V2ProjectNotificationConfig resources.
*/
export interface V2ProjectNotificationConfigState {
/**
* This must be unique within the project.
*/
configId?: pulumi.Input<string>;
/**
* The description of the notification config (max of 1024 characters).
*/
description?: pulumi.Input<string>;
/**
* Location ID of the parent organization. Only global is supported at the moment.
*/
location?: pulumi.Input<string>;
/**
* The resource name of this notification config, in the format
* `projects/{{projectId}}/locations/{{location}}/notificationConfigs/{{config_id}}`.
*/
name?: pulumi.Input<string>;
project?: 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.V2ProjectNotificationConfigStreamingConfig>;
}
/**
* The set of arguments for constructing a V2ProjectNotificationConfig resource.
*/
export interface V2ProjectNotificationConfigArgs {
/**
* This must be unique within the project.
*/
configId: pulumi.Input<string>;
/**
* The description of the notification config (max of 1024 characters).
*/
description?: pulumi.Input<string>;
/**
* Location ID of the parent organization. Only global is supported at the moment.
*/
location?: pulumi.Input<string>;
project?: 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.V2ProjectNotificationConfigStreamingConfig>;
}