published on Monday, Jun 22, 2026 by Pulumi
published on Monday, Jun 22, 2026 by Pulumi
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
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"]))
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
})
}
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 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
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"])
}
Create CustomList Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CustomList(name: string, args: CustomListArgs, opts?: CustomResourceOptions);@overload
def CustomList(resource_name: str,
args: CustomListArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CustomList(resource_name: str,
opts: Optional[ResourceOptions] = None,
category: Optional[str] = None,
entity_identifier: Optional[str] = None,
environments: Optional[str] = None,
instance: Optional[str] = None,
location: Optional[str] = None,
deletion_policy: Optional[str] = None,
project: Optional[str] = None)func NewCustomList(ctx *Context, name string, args CustomListArgs, opts ...ResourceOption) (*CustomList, error)public CustomList(string name, CustomListArgs args, CustomResourceOptions? opts = null)
public CustomList(String name, CustomListArgs args)
public CustomList(String name, CustomListArgs args, CustomResourceOptions options)
type: gcp:chronicle:CustomList
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "gcp_chronicle_customlist" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args CustomListArgs
- 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 CustomListArgs
- 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 CustomListArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CustomListArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CustomListArgs
- 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 customListResource = new Gcp.Chronicle.CustomList("customListResource", new()
{
Category = "string",
EntityIdentifier = "string",
Environments = "string",
Instance = "string",
Location = "string",
DeletionPolicy = "string",
Project = "string",
});
example, err := chronicle.NewCustomList(ctx, "customListResource", &chronicle.CustomListArgs{
Category: pulumi.String("string"),
EntityIdentifier: pulumi.String("string"),
Environments: pulumi.String("string"),
Instance: pulumi.String("string"),
Location: pulumi.String("string"),
DeletionPolicy: pulumi.String("string"),
Project: pulumi.String("string"),
})
resource "gcp_chronicle_customlist" "customListResource" {
category = "string"
entity_identifier = "string"
environments = "string"
instance = "string"
location = "string"
deletion_policy = "string"
project = "string"
}
var customListResource = new CustomList("customListResource", CustomListArgs.builder()
.category("string")
.entityIdentifier("string")
.environments("string")
.instance("string")
.location("string")
.deletionPolicy("string")
.project("string")
.build());
custom_list_resource = gcp.chronicle.CustomList("customListResource",
category="string",
entity_identifier="string",
environments="string",
instance="string",
location="string",
deletion_policy="string",
project="string")
const customListResource = new gcp.chronicle.CustomList("customListResource", {
category: "string",
entityIdentifier: "string",
environments: "string",
instance: "string",
location: "string",
deletionPolicy: "string",
project: "string",
});
type: gcp:chronicle:CustomList
properties:
category: string
deletionPolicy: string
entityIdentifier: string
environments: string
instance: string
location: string
project: string
CustomList 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 CustomList resource accepts the following input properties:
- Category string
- The value of the custom list. Maximum length: 1024 characters
- Entity
Identifier string - The key of the custom list. Maximum length: 2048 characters
- Environments string
- The environments to which the custom list is associated.
- Instance string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Deletion
Policy 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Category string
- The value of the custom list. Maximum length: 1024 characters
- Entity
Identifier string - The key of the custom list. Maximum length: 2048 characters
- Environments string
- The environments to which the custom list is associated.
- Instance string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Deletion
Policy 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category string
- The value of the custom list. Maximum length: 1024 characters
- entity_
identifier string - The key of the custom list. Maximum length: 2048 characters
- environments string
- The environments to which the custom list is associated.
- instance string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - deletion_
policy 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.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category String
- The value of the custom list. Maximum length: 1024 characters
- entity
Identifier String - The key of the custom list. Maximum length: 2048 characters
- environments String
- The environments to which the custom list is associated.
- instance String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - deletion
Policy 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category string
- The value of the custom list. Maximum length: 1024 characters
- entity
Identifier string - The key of the custom list. Maximum length: 2048 characters
- environments string
- The environments to which the custom list is associated.
- instance string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - deletion
Policy 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.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category str
- The value of the custom list. Maximum length: 1024 characters
- entity_
identifier str - The key of the custom list. Maximum length: 2048 characters
- environments str
- The environments to which the custom list is associated.
- instance str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - deletion_
policy str - 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.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category String
- The value of the custom list. Maximum length: 1024 characters
- entity
Identifier String - The key of the custom list. Maximum length: 2048 characters
- environments String
- The environments to which the custom list is associated.
- instance String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - deletion
Policy 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the CustomList resource produces the following output properties:
- Custom
List stringId - Id of the Custom List record.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Identifier. The resource name of the custom list.
- Custom
List stringId - Id of the Custom List record.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Identifier. The resource name of the custom list.
- custom_
list_ stringid - Id of the Custom List record.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Identifier. The resource name of the custom list.
- custom
List StringId - Id of the Custom List record.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Identifier. The resource name of the custom list.
- custom
List stringId - Id of the Custom List record.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- Identifier. The resource name of the custom list.
- custom_
list_ strid - Id of the Custom List record.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- Identifier. The resource name of the custom list.
- custom
List StringId - Id of the Custom List record.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- Identifier. The resource name of the custom list.
Look up Existing CustomList Resource
Get an existing CustomList 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?: CustomListState, opts?: CustomResourceOptions): CustomList@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
category: Optional[str] = None,
custom_list_id: Optional[str] = None,
deletion_policy: Optional[str] = None,
entity_identifier: Optional[str] = None,
environments: Optional[str] = None,
instance: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
project: Optional[str] = None) -> CustomListfunc GetCustomList(ctx *Context, name string, id IDInput, state *CustomListState, opts ...ResourceOption) (*CustomList, error)public static CustomList Get(string name, Input<string> id, CustomListState? state, CustomResourceOptions? opts = null)public static CustomList get(String name, Output<String> id, CustomListState state, CustomResourceOptions options)resources: _: type: gcp:chronicle:CustomList get: id: ${id}import {
to = gcp_chronicle_customlist.example
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.
- Category string
- The value of the custom list. Maximum length: 1024 characters
- Custom
List stringId - Id of the Custom List record.
- Deletion
Policy 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.
- Entity
Identifier string - The key of the custom list. Maximum length: 2048 characters
- Environments string
- The environments to which the custom list is associated.
- Instance string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Name string
- Identifier. The resource name of the custom list.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Category string
- The value of the custom list. Maximum length: 1024 characters
- Custom
List stringId - Id of the Custom List record.
- Deletion
Policy 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.
- Entity
Identifier string - The key of the custom list. Maximum length: 2048 characters
- Environments string
- The environments to which the custom list is associated.
- Instance string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - Name string
- Identifier. The resource name of the custom list.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category string
- The value of the custom list. Maximum length: 1024 characters
- custom_
list_ stringid - Id of the Custom List record.
- deletion_
policy 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.
- entity_
identifier string - The key of the custom list. Maximum length: 2048 characters
- environments string
- The environments to which the custom list is associated.
- instance string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name string
- Identifier. The resource name of the custom list.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category String
- The value of the custom list. Maximum length: 1024 characters
- custom
List StringId - Id of the Custom List record.
- deletion
Policy 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.
- entity
Identifier String - The key of the custom list. Maximum length: 2048 characters
- environments String
- The environments to which the custom list is associated.
- instance String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name String
- Identifier. The resource name of the custom list.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category string
- The value of the custom list. Maximum length: 1024 characters
- custom
List stringId - Id of the Custom List record.
- deletion
Policy 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.
- entity
Identifier string - The key of the custom list. Maximum length: 2048 characters
- environments string
- The environments to which the custom list is associated.
- instance string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location string
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name string
- Identifier. The resource name of the custom list.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category str
- The value of the custom list. Maximum length: 1024 characters
- custom_
list_ strid - Id of the Custom List record.
- deletion_
policy str - 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.
- entity_
identifier str - The key of the custom list. Maximum length: 2048 characters
- environments str
- The environments to which the custom list is associated.
- instance str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location str
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name str
- Identifier. The resource name of the custom list.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- category String
- The value of the custom list. Maximum length: 1024 characters
- custom
List StringId - Id of the Custom List record.
- deletion
Policy 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.
- entity
Identifier String - The key of the custom list. Maximum length: 2048 characters
- environments String
- The environments to which the custom list is associated.
- instance String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - location String
- Resource ID segment making up resource
name. It identifies the resource within its parent collection as described in https://google.aip.dev/122. - name String
- Identifier. The resource name of the custom list.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
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}}
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-betaTerraform Provider.
published on Monday, Jun 22, 2026 by Pulumi