pulumi-gcp-kotlin/com.pulumi.gcp.chronicle.kotlin/WatchlistArgs

WatchlistArgs

data class WatchlistArgs(val description: Output<String>? = null, val displayName: Output<String>? = null, val entityPopulationMechanism: Output<WatchlistEntityPopulationMechanismArgs>? = null, val instance: Output<String>? = null, val location: Output<String>? = null, val multiplyingFactor: Output<Double>? = null, val project: Output<String>? = null, val watchlistId: Output<String>? = null, val watchlistUserPreferences: Output<WatchlistWatchlistUserPreferencesArgs>? = null) : ConvertibleToJava<WatchlistArgs>

A watchlist is a list of entities that allows for bulk operations over the included entities. To get more information about Watchlist, see:

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,
    },
});
Content copied to clipboard
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,
    })
Content copied to clipboard
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,
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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.0)
            .entityPopulationMechanism(WatchlistEntityPopulationMechanismArgs.builder()
                .manual(WatchlistEntityPopulationMechanismManualArgs.builder()
                    .build())
                .build())
            .watchlistUserPreferences(WatchlistWatchlistUserPreferencesArgs.builder()
                .pinned(true)
                .build())
            .build());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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,
    },
});
Content copied to clipboard
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,
    })
Content copied to clipboard
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,
        },
    });
});
Content copied to clipboard
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
	})
}
Content copied to clipboard
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.0)
            .entityPopulationMechanism(WatchlistEntityPopulationMechanismArgs.builder()
                .manual(WatchlistEntityPopulationMechanismManualArgs.builder()
                    .build())
                .build())
            .watchlistUserPreferences(WatchlistWatchlistUserPreferencesArgs.builder()
                .pinned(true)
                .build())
            .build());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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}}
Content copied to clipboard
$ pulumi import gcp:chronicle/watchlist:Watchlist default {{project}}/{{location}}/{{instance}}/{{watchlist_id}}
Content copied to clipboard
$ pulumi import gcp:chronicle/watchlist:Watchlist default {{location}}/{{instance}}/{{watchlist_id}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, displayName: Output<String>? = null, entityPopulationMechanism: Output<WatchlistEntityPopulationMechanismArgs>? = null, instance: Output<String>? = null, location: Output<String>? = null, multiplyingFactor: Output<Double>? = null, project: Output<String>? = null, watchlistId: Output<String>? = null, watchlistUserPreferences: Output<WatchlistWatchlistUserPreferencesArgs>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

Optional. Description of the watchlist.

Link copied to clipboard
val displayName: Output<String>? = null

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).

Link copied to clipboard
val entityPopulationMechanism: Output<WatchlistEntityPopulationMechanismArgs>? = null

Mechanism to populate entities in the watchlist. Structure is documented below.

Link copied to clipboard
val instance: Output<String>? = null

The unique identifier for the Chronicle instance, which is the same as the customer ID.

Link copied to clipboard
val location: Output<String>? = null

The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".

Link copied to clipboard
val multiplyingFactor: Output<Double>? = null

Optional. Weight applied to the risk score for entities in this watchlist. The default is 1.0 if it is not specified.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val watchlistId: Output<String>? = null

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-/.

Link copied to clipboard
val watchlistUserPreferences: Output<WatchlistWatchlistUserPreferencesArgs>? = null

A collection of user preferences for watchlist UI configuration.

Functions

Link copied to clipboard
open override fun toJava(): WatchlistArgs