@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
202 lines • 8.73 kB
TypeScript
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 ProjectNotificationConfig, see:
*
* * [API documentation](https://cloud.google.com/security-command-center/docs/reference/rest/v1/projects.notificationConfigs)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/security-command-center/docs)
*
* ## Example Usage
*
* ### Scc Project Notification Config Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const sccProjectNotification = new gcp.pubsub.Topic("scc_project_notification", {name: "my-topic"});
* const customNotificationConfig = new gcp.securitycenter.ProjectNotificationConfig("custom_notification_config", {
* configId: "my-config",
* project: "my-project-name",
* description: "My custom Cloud Security Command Center Finding Notification Configuration",
* pubsubTopic: sccProjectNotification.id,
* streamingConfig: {
* filter: "category = \"OPEN_FIREWALL\" AND state = \"ACTIVE\"",
* },
* });
* ```
*
* ## Import
*
* ProjectNotificationConfig can be imported using any of these accepted formats:
*
* * `{{name}}`
*
* When using the `pulumi import` command, ProjectNotificationConfig can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:securitycenter/projectNotificationConfig:ProjectNotificationConfig default {{name}}
* ```
*/
export declare class ProjectNotificationConfig extends pulumi.CustomResource {
/**
* Get an existing ProjectNotificationConfig 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?: ProjectNotificationConfigState, opts?: pulumi.CustomResourceOptions): ProjectNotificationConfig;
/**
* Returns true if the given object is an instance of ProjectNotificationConfig. 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 ProjectNotificationConfig;
/**
* This must be unique within the organization.
*/
readonly configId: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The description of the notification config (max of 1024 characters).
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The resource name of this notification config, in the format
* `projects/{{projectId}}/notificationConfigs/{{config_id}}`.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
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>;
/**
* 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.ProjectNotificationConfigStreamingConfig>;
/**
* Create a ProjectNotificationConfig 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: ProjectNotificationConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProjectNotificationConfig resources.
*/
export interface ProjectNotificationConfigState {
/**
* This must be unique within the organization.
*/
configId?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The description of the notification config (max of 1024 characters).
*/
description?: pulumi.Input<string | undefined>;
/**
* The resource name of this notification config, in the format
* `projects/{{projectId}}/notificationConfigs/{{config_id}}`.
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The Pub/Sub topic to send notifications to. Its format is
* "projects/[projectId]/topics/[topic]".
*/
pubsubTopic?: pulumi.Input<string | undefined>;
/**
* The service account that needs "pubsub.topics.publish" permission to
* publish to the Pub/Sub topic.
*/
serviceAccount?: pulumi.Input<string | undefined>;
/**
* The config for triggering streaming-based notifications.
* Structure is documented below.
*/
streamingConfig?: pulumi.Input<inputs.securitycenter.ProjectNotificationConfigStreamingConfig | undefined>;
}
/**
* The set of arguments for constructing a ProjectNotificationConfig resource.
*/
export interface ProjectNotificationConfigArgs {
/**
* This must be unique within the organization.
*/
configId: pulumi.Input<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The description of the notification config (max of 1024 characters).
*/
description?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* 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.ProjectNotificationConfigStreamingConfig>;
}
//# sourceMappingURL=projectNotificationConfig.d.ts.map