import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * A watchlist is a list of entities that allows for bulk operations over the included entities. * * To get more information about Watchlist, see: * * * [API documentation](https://cloud.google.com/chronicle/docs/reference/rest/v1/projects.locations.instances.watchlists) * * How-to Guides * * [Google SecOps Guides](https://cloud.google.com/chronicle/docs/secops/secops-overview) * * ## Example Usage * * ### Chronicle Watchlist Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.chronicle.Watchlist("example", { * location: "us", * instance: "00000000-0000-0000-0000-000000000000", * watchlistId: "watchlist-id", * description: "watchlist-description", * displayName: "watchlist_name", * multiplyingFactor: 1, * entityPopulationMechanism: { * manual: {}, * }, * watchlistUserPreferences: { * pinned: true, * }, * }); * ``` * ### Chronicle Watchlist Without Id * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.chronicle.Watchlist("example", { * location: "us", * instance: "00000000-0000-0000-0000-000000000000", * description: "watchlist-description", * displayName: "watchlist-name", * multiplyingFactor: 1, * entityPopulationMechanism: { * manual: {}, * }, * watchlistUserPreferences: { * pinned: true, * }, * }); * ``` * * ## Import * * Watchlist can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/instances/{{instance}}/watchlists/{{watchlist_id}}` * * `{{project}}/{{location}}/{{instance}}/{{watchlist_id}}` * * `{{location}}/{{instance}}/{{watchlist_id}}` * * When using the `pulumi import` command, Watchlist can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:chronicle/watchlist:Watchlist default projects/{{project}}/locations/{{location}}/instances/{{instance}}/watchlists/{{watchlist_id}} * $ pulumi import gcp:chronicle/watchlist:Watchlist default {{project}}/{{location}}/{{instance}}/{{watchlist_id}} * $ pulumi import gcp:chronicle/watchlist:Watchlist default {{location}}/{{instance}}/{{watchlist_id}} * ``` */ export declare class Watchlist extends pulumi.CustomResource { /** * Get an existing Watchlist 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, state?: WatchlistState, opts?: pulumi.CustomResourceOptions): Watchlist; /** * Returns true if the given object is an instance of Watchlist. 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 Watchlist; /** * Output only. Time the watchlist was created. */ readonly createTime: pulumi.Output; /** * 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; /** * Optional. Description of the watchlist. */ readonly description: pulumi.Output; /** * Required. Display name of the watchlist. * Note that it must be at least one character and less than 63 characters * (https://google.aip.dev/148). */ readonly displayName: pulumi.Output; /** * Count of different types of entities in the watchlist. * Structure is documented below. */ readonly entityCounts: pulumi.Output; /** * Mechanism to populate entities in the watchlist. * Structure is documented below. */ readonly entityPopulationMechanism: pulumi.Output; /** * The unique identifier for the Chronicle instance, which is the same as the customer ID. */ readonly instance: pulumi.Output; /** * The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2". */ readonly location: pulumi.Output; /** * Optional. Weight applied to the risk score for entities * in this watchlist. * The default is 1.0 if it is not specified. */ readonly multiplyingFactor: pulumi.Output; /** * Identifier. Resource name of the watchlist. This unique identifier is generated using values provided for the URL parameters. * Format: * projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist} */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * Output only. Time the watchlist was last updated. */ readonly updateTime: pulumi.Output; /** * Optional. The ID to use for the watchlist, * which will become the final component of the watchlist's resource name. * This value should be 4-63 characters, and valid characters * are /a-z-/. */ readonly watchlistId: pulumi.Output; /** * A collection of user preferences for watchlist UI configuration. * Structure is documented below. */ readonly watchlistUserPreferences: pulumi.Output; /** * Create a Watchlist 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: WatchlistArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Watchlist resources. */ export interface WatchlistState { /** * Output only. Time the watchlist was created. */ createTime?: pulumi.Input; /** * 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; /** * Optional. Description of the watchlist. */ description?: pulumi.Input; /** * Required. Display name of the watchlist. * Note that it must be at least one character and less than 63 characters * (https://google.aip.dev/148). */ displayName?: pulumi.Input; /** * Count of different types of entities in the watchlist. * Structure is documented below. */ entityCounts?: pulumi.Input[] | undefined>; /** * Mechanism to populate entities in the watchlist. * Structure is documented below. */ entityPopulationMechanism?: pulumi.Input; /** * The unique identifier for the Chronicle instance, which is the same as the customer ID. */ instance?: pulumi.Input; /** * The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2". */ location?: pulumi.Input; /** * Optional. Weight applied to the risk score for entities * in this watchlist. * The default is 1.0 if it is not specified. */ multiplyingFactor?: pulumi.Input; /** * Identifier. Resource name of the watchlist. This unique identifier is generated using values provided for the URL parameters. * Format: * projects/{project}/locations/{location}/instances/{instance}/watchlists/{watchlist} */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Output only. Time the watchlist was last updated. */ updateTime?: pulumi.Input; /** * Optional. The ID to use for the watchlist, * which will become the final component of the watchlist's resource name. * This value should be 4-63 characters, and valid characters * are /a-z-/. */ watchlistId?: pulumi.Input; /** * A collection of user preferences for watchlist UI configuration. * Structure is documented below. */ watchlistUserPreferences?: pulumi.Input; } /** * The set of arguments for constructing a Watchlist resource. */ export interface WatchlistArgs { /** * 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; /** * Optional. Description of the watchlist. */ description?: pulumi.Input; /** * Required. Display name of the watchlist. * Note that it must be at least one character and less than 63 characters * (https://google.aip.dev/148). */ displayName: pulumi.Input; /** * Mechanism to populate entities in the watchlist. * Structure is documented below. */ entityPopulationMechanism: pulumi.Input; /** * The unique identifier for the Chronicle instance, which is the same as the customer ID. */ instance: pulumi.Input; /** * The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2". */ location: pulumi.Input; /** * Optional. Weight applied to the risk score for entities * in this watchlist. * The default is 1.0 if it is not specified. */ multiplyingFactor?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * Optional. The ID to use for the watchlist, * which will become the final component of the watchlist's resource name. * This value should be 4-63 characters, and valid characters * are /a-z-/. */ watchlistId?: pulumi.Input; /** * A collection of user preferences for watchlist UI configuration. * Structure is documented below. */ watchlistUserPreferences?: pulumi.Input; } //# sourceMappingURL=watchlist.d.ts.map