CustomList class

The custom list is a list of objects, that can be saved as a shared resource, and can be used by playbooks.

To get more information about CustomList, see:

• API documentation
• How-to Guides
• Google SecOps Guides

Example Usage

Chronicle Customlist Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const sample = new gcp.chronicle.CustomList("sample", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    entityIdentifier: "filename.bin",
    category: "Approved Files",
    environments: JSON.stringify(["Default Environment"]),
});

import pulumi
import json
import pulumi_gcp as gcp

sample = gcp.chronicle.CustomList("sample",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    entity_identifier="filename.bin",
    category="Approved Files",
    environments=json.dumps(["Default Environment"]))

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

return await Deployment.RunAsync(() =>
{
    var sample = new Gcp.Chronicle.CustomList("sample", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        EntityIdentifier = "filename.bin",
        Category = "Approved Files",
        Environments = JsonSerializer.Serialize(new[]
        {
            "Default Environment",
        }),
    });

});

package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/chronicle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal([]string{
			"Default Environment",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = chronicle.NewCustomList(ctx, "sample", &chronicle.CustomListArgs{
			Location:         pulumi.String("us"),
			Instance:         pulumi.String("00000000-0000-0000-0000-000000000000"),
			EntityIdentifier: pulumi.String("filename.bin"),
			Category:         pulumi.String("Approved Files"),
			Environments:     pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_chronicle_customlist" "sample" {
  location          = "us"
  instance          = "00000000-0000-0000-0000-000000000000"
  entity_identifier = "filename.bin"
  category          = "Approved Files"
  environments      = jsonencode(["Default Environment"])
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.CustomList;
import com.pulumi.gcp.chronicle.CustomListArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.ArrayList;
import java.util.Arrays;
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 sample = new CustomList("sample", CustomListArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .entityIdentifier("filename.bin")
            .category("Approved Files")
            .environments(serializeJson(
                jsonArray("Default Environment")))
            .build());

    }
}

resources:
  sample:
    type: gcp:chronicle:CustomList
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      entityIdentifier: filename.bin
      category: Approved Files
      environments:
        fn::toJSON:
          - Default Environment

Import

CustomList can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/instances/{{instance}}/customLists/{{custom_list_id}}
• {{project}}/{{location}}/{{instance}}/{{custom_list_id}}
• {{location}}/{{instance}}/{{custom_list_id}}

When using the pulumi import command, CustomList can be imported using one of the formats above. For example:

$ pulumi import gcp:chronicle/customList:CustomList default projects/{{project}}/locations/{{location}}/instances/{{instance}}/customLists/{{custom_list_id}}
$ pulumi import gcp:chronicle/customList:CustomList default {{project}}/{{location}}/{{instance}}/{{custom_list_id}}
$ pulumi import gcp:chronicle/customList:CustomList default {{location}}/{{instance}}/{{custom_list_id}}

Constructors

CustomList(String name, {CustomListArgs? args, CustomResourceOptions? options})

Creates a new CustomList. name The Pulumi resource name. args Arguments used to configure this CustomList. The set of arguments for CustomList. options Resource options controlling this resource's behavior.

CustomList.reference(String urn)

Creates a typed reference to an existing CustomList resource.

Properties

category ↔ Output<String>

The value of the custom list. Maximum length: 1024 characters

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

customListId ↔ Output<String>

Id of the Custom List record.

late, final

deletionPolicy ↔ 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.

late, final

entityIdentifier ↔ Output<String>

The key of the custom list. Maximum length: 2048 characters

late, final

environments ↔ Output<String>

The environments to which the custom list is associated.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

instance ↔ Output<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

name ↔ Output<String>

Identifier. The resource name of the custom list.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {CustomListState? state, CustomResourceOptions? options}) → CustomList

Gets an existing CustomList resource's state with the given name and id.