Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. chronicle
  5. Watchlist
Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.chronicle.Watchlist

Explore with Pulumi AI

gcp logo
Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-gcp

    Example Usage

    Chronicle Watchlist Basic

    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,
    },
});

    import pulumi
import pulumi_gcp as gcp

example = gcp.chronicle.Watchlist("example",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    watchlist_id="watchlist-id",
    description="watchlist-description",
    display_name="watchlist_name",
    multiplying_factor=1,
    entity_population_mechanism={
        "manual": {},
    },
    watchlist_user_preferences={
        "pinned": True,
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/chronicle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := chronicle.NewWatchlist(ctx, "example", &chronicle.WatchlistArgs{
			Location:          pulumi.String("us"),
			Instance:          pulumi.String("00000000-0000-0000-0000-000000000000"),
			WatchlistId:       pulumi.String("watchlist-id"),
			Description:       pulumi.String("watchlist-description"),
			DisplayName:       pulumi.String("watchlist_name"),
			MultiplyingFactor: pulumi.Float64(1),
			EntityPopulationMechanism: &chronicle.WatchlistEntityPopulationMechanismArgs{
				Manual: &chronicle.WatchlistEntityPopulationMechanismManualArgs{},
			},
			WatchlistUserPreferences: &chronicle.WatchlistWatchlistUserPreferencesArgs{
				Pinned: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var example = new Gcp.Chronicle.Watchlist("example", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        WatchlistId = "watchlist-id",
        Description = "watchlist-description",
        DisplayName = "watchlist_name",
        MultiplyingFactor = 1,
        EntityPopulationMechanism = new Gcp.Chronicle.Inputs.WatchlistEntityPopulationMechanismArgs
        {
            Manual = null,
        },
        WatchlistUserPreferences = new Gcp.Chronicle.Inputs.WatchlistWatchlistUserPreferencesArgs
        {
            Pinned = true,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.Watchlist;
import com.pulumi.gcp.chronicle.WatchlistArgs;
import com.pulumi.gcp.chronicle.inputs.WatchlistEntityPopulationMechanismArgs;
import com.pulumi.gcp.chronicle.inputs.WatchlistEntityPopulationMechanismManualArgs;
import com.pulumi.gcp.chronicle.inputs.WatchlistWatchlistUserPreferencesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Watchlist("example", WatchlistArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .watchlistId("watchlist-id")
            .description("watchlist-description")
            .displayName("watchlist_name")
            .multiplyingFactor(1)
            .entityPopulationMechanism(WatchlistEntityPopulationMechanismArgs.builder()
                .manual()
                .build())
            .watchlistUserPreferences(WatchlistWatchlistUserPreferencesArgs.builder()
                .pinned(true)
                .build())
            .build());

    }
}

    resources:
  example:
    type: gcp:chronicle:Watchlist
    properties:
      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

    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 pulumi
import pulumi_gcp as gcp

example = gcp.chronicle.Watchlist("example",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    description="watchlist-description",
    display_name="watchlist-name",
    multiplying_factor=1,
    entity_population_mechanism={
        "manual": {},
    },
    watchlist_user_preferences={
        "pinned": True,
    })

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/chronicle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := chronicle.NewWatchlist(ctx, "example", &chronicle.WatchlistArgs{
			Location:          pulumi.String("us"),
			Instance:          pulumi.String("00000000-0000-0000-0000-000000000000"),
			Description:       pulumi.String("watchlist-description"),
			DisplayName:       pulumi.String("watchlist-name"),
			MultiplyingFactor: pulumi.Float64(1),
			EntityPopulationMechanism: &chronicle.WatchlistEntityPopulationMechanismArgs{
				Manual: &chronicle.WatchlistEntityPopulationMechanismManualArgs{},
			},
			WatchlistUserPreferences: &chronicle.WatchlistWatchlistUserPreferencesArgs{
				Pinned: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var example = new Gcp.Chronicle.Watchlist("example", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        Description = "watchlist-description",
        DisplayName = "watchlist-name",
        MultiplyingFactor = 1,
        EntityPopulationMechanism = new Gcp.Chronicle.Inputs.WatchlistEntityPopulationMechanismArgs
        {
            Manual = null,
        },
        WatchlistUserPreferences = new Gcp.Chronicle.Inputs.WatchlistWatchlistUserPreferencesArgs
        {
            Pinned = true,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.Watchlist;
import com.pulumi.gcp.chronicle.WatchlistArgs;
import com.pulumi.gcp.chronicle.inputs.WatchlistEntityPopulationMechanismArgs;
import com.pulumi.gcp.chronicle.inputs.WatchlistEntityPopulationMechanismManualArgs;
import com.pulumi.gcp.chronicle.inputs.WatchlistWatchlistUserPreferencesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Watchlist("example", WatchlistArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .description("watchlist-description")
            .displayName("watchlist-name")
            .multiplyingFactor(1)
            .entityPopulationMechanism(WatchlistEntityPopulationMechanismArgs.builder()
                .manual()
                .build())
            .watchlistUserPreferences(WatchlistWatchlistUserPreferencesArgs.builder()
                .pinned(true)
                .build())
            .build());

    }
}

    resources:
  example:
    type: gcp:chronicle:Watchlist
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      description: watchlist-description
      displayName: watchlist-name
      multiplyingFactor: 1
      entityPopulationMechanism:
        manual: {}
      watchlistUserPreferences:
        pinned: true

    Create Watchlist Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Watchlist(name: string, args: WatchlistArgs, opts?: CustomResourceOptions);
    @overload
def Watchlist(resource_name: str,
              args: WatchlistArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Watchlist(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              display_name: Optional[str] = None,
              entity_population_mechanism: Optional[WatchlistEntityPopulationMechanismArgs] = None,
              instance: Optional[str] = None,
              location: Optional[str] = None,
              description: Optional[str] = None,
              multiplying_factor: Optional[float] = None,
              project: Optional[str] = None,
              watchlist_id: Optional[str] = None,
              watchlist_user_preferences: Optional[WatchlistWatchlistUserPreferencesArgs] = None)
    func NewWatchlist(ctx *Context, name string, args WatchlistArgs, opts ...ResourceOption) (*Watchlist, error)
    public Watchlist(string name, WatchlistArgs args, CustomResourceOptions? opts = null)
    public Watchlist(String name, WatchlistArgs args)
public Watchlist(String name, WatchlistArgs args, CustomResourceOptions options)

    type: gcp:chronicle:Watchlist
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WatchlistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WatchlistArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WatchlistArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WatchlistArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WatchlistArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var watchlistResource = new Gcp.Chronicle.Watchlist("watchlistResource", new()
{
    DisplayName = "string",
    EntityPopulationMechanism = new Gcp.Chronicle.Inputs.WatchlistEntityPopulationMechanismArgs
    {
        Manual = null,
    },
    Instance = "string",
    Location = "string",
    Description = "string",
    MultiplyingFactor = 0,
    Project = "string",
    WatchlistId = "string",
    WatchlistUserPreferences = new Gcp.Chronicle.Inputs.WatchlistWatchlistUserPreferencesArgs
    {
        Pinned = false,
    },
});

    example, err := chronicle.NewWatchlist(ctx, "watchlistResource", &chronicle.WatchlistArgs{
	DisplayName: pulumi.String("string"),
	EntityPopulationMechanism: &chronicle.WatchlistEntityPopulationMechanismArgs{
		Manual: &chronicle.WatchlistEntityPopulationMechanismManualArgs{},
	},
	Instance:          pulumi.String("string"),
	Location:          pulumi.String("string"),
	Description:       pulumi.String("string"),
	MultiplyingFactor: pulumi.Float64(0),
	Project:           pulumi.String("string"),
	WatchlistId:       pulumi.String("string"),
	WatchlistUserPreferences: &chronicle.WatchlistWatchlistUserPreferencesArgs{
		Pinned: pulumi.Bool(false),
	},
})

    var watchlistResource = new Watchlist("watchlistResource", WatchlistArgs.builder()
    .displayName("string")
    .entityPopulationMechanism(WatchlistEntityPopulationMechanismArgs.builder()
        .manual()
        .build())
    .instance("string")
    .location("string")
    .description("string")
    .multiplyingFactor(0)
    .project("string")
    .watchlistId("string")
    .watchlistUserPreferences(WatchlistWatchlistUserPreferencesArgs.builder()
        .pinned(false)
        .build())
    .build());

    watchlist_resource = gcp.chronicle.Watchlist("watchlistResource",
    display_name="string",
    entity_population_mechanism={
        "manual": {},
    },
    instance="string",
    location="string",
    description="string",
    multiplying_factor=0,
    project="string",
    watchlist_id="string",
    watchlist_user_preferences={
        "pinned": False,
    })

    const watchlistResource = new gcp.chronicle.Watchlist("watchlistResource", {
    displayName: "string",
    entityPopulationMechanism: {
        manual: {},
    },
    instance: "string",
    location: "string",
    description: "string",
    multiplyingFactor: 0,
    project: "string",
    watchlistId: "string",
    watchlistUserPreferences: {
        pinned: false,
    },
});

    type: gcp:chronicle:Watchlist
properties:
    description: string
    displayName: string
    entityPopulationMechanism:
        manual: {}
    instance: string
    location: string
    multiplyingFactor: 0
    project: string
    watchlistId: string
    watchlistUserPreferences:
        pinned: false

    Watchlist Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Watchlist resource accepts the following input properties:

    DisplayName string
    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).
    EntityPopulationMechanism WatchlistEntityPopulationMechanism
    Mechanism to populate entities in the watchlist. Structure is documented below.
    Instance string
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    Location string
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    Description string
    Optional. Description of the watchlist.
    MultiplyingFactor double
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    Project string
    WatchlistId string
    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-/.
    WatchlistUserPreferences WatchlistWatchlistUserPreferences
    A collection of user preferences for watchlist UI configuration.
    DisplayName string
    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).
    EntityPopulationMechanism WatchlistEntityPopulationMechanismArgs
    Mechanism to populate entities in the watchlist. Structure is documented below.
    Instance string
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    Location string
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    Description string
    Optional. Description of the watchlist.
    MultiplyingFactor float64
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    Project string
    WatchlistId string
    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-/.
    WatchlistUserPreferences WatchlistWatchlistUserPreferencesArgs
    A collection of user preferences for watchlist UI configuration.
    displayName String
    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).
    entityPopulationMechanism WatchlistEntityPopulationMechanism
    Mechanism to populate entities in the watchlist. Structure is documented below.
    instance String
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    location String
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    description String
    Optional. Description of the watchlist.
    multiplyingFactor Double
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    project String
    watchlistId String
    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-/.
    watchlistUserPreferences WatchlistWatchlistUserPreferences
    A collection of user preferences for watchlist UI configuration.
    displayName string
    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).
    entityPopulationMechanism WatchlistEntityPopulationMechanism
    Mechanism to populate entities in the watchlist. Structure is documented below.
    instance string
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    location string
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    description string
    Optional. Description of the watchlist.
    multiplyingFactor number
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    project string
    watchlistId string
    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-/.
    watchlistUserPreferences WatchlistWatchlistUserPreferences
    A collection of user preferences for watchlist UI configuration.
    display_name str
    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).
    entity_population_mechanism WatchlistEntityPopulationMechanismArgs
    Mechanism to populate entities in the watchlist. Structure is documented below.
    instance str
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    location str
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    description str
    Optional. Description of the watchlist.
    multiplying_factor float
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    project str
    watchlist_id str
    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-/.
    watchlist_user_preferences WatchlistWatchlistUserPreferencesArgs
    A collection of user preferences for watchlist UI configuration.
    displayName String
    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).
    entityPopulationMechanism Property Map
    Mechanism to populate entities in the watchlist. Structure is documented below.
    instance String
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    location String
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    description String
    Optional. Description of the watchlist.
    multiplyingFactor Number
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    project String
    watchlistId String
    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-/.
    watchlistUserPreferences Property Map
    A collection of user preferences for watchlist UI configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Watchlist resource produces the following output properties:

    CreateTime string
    Output only. Time the watchlist was created.
    EntityCounts List<WatchlistEntityCount>
    Count of different types of entities in the watchlist. Structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    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}
    UpdateTime string
    Output only. Time the watchlist was last updated.
    CreateTime string
    Output only. Time the watchlist was created.
    EntityCounts []WatchlistEntityCount
    Count of different types of entities in the watchlist. Structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    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}
    UpdateTime string
    Output only. Time the watchlist was last updated.
    createTime String
    Output only. Time the watchlist was created.
    entityCounts List<WatchlistEntityCount>
    Count of different types of entities in the watchlist. Structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    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}
    updateTime String
    Output only. Time the watchlist was last updated.
    createTime string
    Output only. Time the watchlist was created.
    entityCounts WatchlistEntityCount[]
    Count of different types of entities in the watchlist. Structure is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    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}
    updateTime string
    Output only. Time the watchlist was last updated.
    create_time str
    Output only. Time the watchlist was created.
    entity_counts Sequence[WatchlistEntityCount]
    Count of different types of entities in the watchlist. Structure is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    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}
    update_time str
    Output only. Time the watchlist was last updated.
    createTime String
    Output only. Time the watchlist was created.
    entityCounts List<Property Map>
    Count of different types of entities in the watchlist. Structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    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}
    updateTime String
    Output only. Time the watchlist was last updated.

    Look up Existing Watchlist Resource

    Get an existing Watchlist resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WatchlistState, opts?: CustomResourceOptions): Watchlist
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        entity_counts: Optional[Sequence[WatchlistEntityCountArgs]] = None,
        entity_population_mechanism: Optional[WatchlistEntityPopulationMechanismArgs] = None,
        instance: Optional[str] = None,
        location: Optional[str] = None,
        multiplying_factor: Optional[float] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        update_time: Optional[str] = None,
        watchlist_id: Optional[str] = None,
        watchlist_user_preferences: Optional[WatchlistWatchlistUserPreferencesArgs] = None) -> Watchlist
    func GetWatchlist(ctx *Context, name string, id IDInput, state *WatchlistState, opts ...ResourceOption) (*Watchlist, error)
    public static Watchlist Get(string name, Input<string> id, WatchlistState? state, CustomResourceOptions? opts = null)
    public static Watchlist get(String name, Output<String> id, WatchlistState state, CustomResourceOptions options)
    resources:  _:    type: gcp:chronicle:Watchlist    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreateTime string
    Output only. Time the watchlist was created.
    Description string
    Optional. Description of the watchlist.
    DisplayName string
    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).
    EntityCounts List<WatchlistEntityCount>
    Count of different types of entities in the watchlist. Structure is documented below.
    EntityPopulationMechanism WatchlistEntityPopulationMechanism
    Mechanism to populate entities in the watchlist. Structure is documented below.
    Instance string
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    Location string
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    MultiplyingFactor double
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    Name string
    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}
    Project string
    UpdateTime string
    Output only. Time the watchlist was last updated.
    WatchlistId string
    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-/.
    WatchlistUserPreferences WatchlistWatchlistUserPreferences
    A collection of user preferences for watchlist UI configuration.
    CreateTime string
    Output only. Time the watchlist was created.
    Description string
    Optional. Description of the watchlist.
    DisplayName string
    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).
    EntityCounts []WatchlistEntityCountArgs
    Count of different types of entities in the watchlist. Structure is documented below.
    EntityPopulationMechanism WatchlistEntityPopulationMechanismArgs
    Mechanism to populate entities in the watchlist. Structure is documented below.
    Instance string
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    Location string
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    MultiplyingFactor float64
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    Name string
    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}
    Project string
    UpdateTime string
    Output only. Time the watchlist was last updated.
    WatchlistId string
    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-/.
    WatchlistUserPreferences WatchlistWatchlistUserPreferencesArgs
    A collection of user preferences for watchlist UI configuration.
    createTime String
    Output only. Time the watchlist was created.
    description String
    Optional. Description of the watchlist.
    displayName String
    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).
    entityCounts List<WatchlistEntityCount>
    Count of different types of entities in the watchlist. Structure is documented below.
    entityPopulationMechanism WatchlistEntityPopulationMechanism
    Mechanism to populate entities in the watchlist. Structure is documented below.
    instance String
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    location String
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    multiplyingFactor Double
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    name String
    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}
    project String
    updateTime String
    Output only. Time the watchlist was last updated.
    watchlistId String
    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-/.
    watchlistUserPreferences WatchlistWatchlistUserPreferences
    A collection of user preferences for watchlist UI configuration.
    createTime string
    Output only. Time the watchlist was created.
    description string
    Optional. Description of the watchlist.
    displayName string
    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).
    entityCounts WatchlistEntityCount[]
    Count of different types of entities in the watchlist. Structure is documented below.
    entityPopulationMechanism WatchlistEntityPopulationMechanism
    Mechanism to populate entities in the watchlist. Structure is documented below.
    instance string
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    location string
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    multiplyingFactor number
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    name string
    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}
    project string
    updateTime string
    Output only. Time the watchlist was last updated.
    watchlistId string
    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-/.
    watchlistUserPreferences WatchlistWatchlistUserPreferences
    A collection of user preferences for watchlist UI configuration.
    create_time str
    Output only. Time the watchlist was created.
    description str
    Optional. Description of the watchlist.
    display_name str
    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).
    entity_counts Sequence[WatchlistEntityCountArgs]
    Count of different types of entities in the watchlist. Structure is documented below.
    entity_population_mechanism WatchlistEntityPopulationMechanismArgs
    Mechanism to populate entities in the watchlist. Structure is documented below.
    instance str
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    location str
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    multiplying_factor float
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    name str
    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}
    project str
    update_time str
    Output only. Time the watchlist was last updated.
    watchlist_id str
    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-/.
    watchlist_user_preferences WatchlistWatchlistUserPreferencesArgs
    A collection of user preferences for watchlist UI configuration.
    createTime String
    Output only. Time the watchlist was created.
    description String
    Optional. Description of the watchlist.
    displayName String
    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).
    entityCounts List<Property Map>
    Count of different types of entities in the watchlist. Structure is documented below.
    entityPopulationMechanism Property Map
    Mechanism to populate entities in the watchlist. Structure is documented below.
    instance String
    The unique identifier for the Chronicle instance, which is the same as the customer ID.
    location String
    The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
    multiplyingFactor Number
    Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.
    name String
    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}
    project String
    updateTime String
    Output only. Time the watchlist was last updated.
    watchlistId String
    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-/.
    watchlistUserPreferences Property Map
    A collection of user preferences for watchlist UI configuration.

    Supporting Types

    WatchlistEntityCount, WatchlistEntityCountArgs

    Asset int
    (Output) Output only. Count of asset type entities in the watchlist.
    User int
    (Output) Output only. Count of user type entities in the watchlist.
    Asset int
    (Output) Output only. Count of asset type entities in the watchlist.
    User int
    (Output) Output only. Count of user type entities in the watchlist.
    asset Integer
    (Output) Output only. Count of asset type entities in the watchlist.
    user Integer
    (Output) Output only. Count of user type entities in the watchlist.
    asset number
    (Output) Output only. Count of asset type entities in the watchlist.
    user number
    (Output) Output only. Count of user type entities in the watchlist.
    asset int
    (Output) Output only. Count of asset type entities in the watchlist.
    user int
    (Output) Output only. Count of user type entities in the watchlist.
    asset Number
    (Output) Output only. Count of asset type entities in the watchlist.
    user Number
    (Output) Output only. Count of user type entities in the watchlist.

    WatchlistEntityPopulationMechanism, WatchlistEntityPopulationMechanismArgs

    manual Property Map
    Entities are added manually.

    WatchlistWatchlistUserPreferences, WatchlistWatchlistUserPreferencesArgs

    Pinned bool
    Optional. Whether the watchlist is pinned on the dashboard.
    Pinned bool
    Optional. Whether the watchlist is pinned on the dashboard.
    pinned Boolean
    Optional. Whether the watchlist is pinned on the dashboard.
    pinned boolean
    Optional. Whether the watchlist is pinned on the dashboard.
    pinned bool
    Optional. Whether the watchlist is pinned on the dashboard.
    pinned Boolean
    Optional. Whether the watchlist is pinned on the dashboard.

    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:

    $ 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}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.22.0 published on Thursday, Mar 13, 2025 by Pulumi
    pulumi/pulumi-gcp