1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. chronicle
  5. ReferenceList
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi

gcp.chronicle.ReferenceList

Explore with Pulumi AI

Example Usage

Chronicle Referencelist Basic

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

const example = new gcp.chronicle.ReferenceList("example", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    referenceListId: "reference_list_id",
    description: "referencelist-description",
    entries: [{
        value: "referencelist-entry-value",
    }],
    syntaxType: "REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING",
});
Copy
import pulumi
import pulumi_gcp as gcp

example = gcp.chronicle.ReferenceList("example",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    reference_list_id="reference_list_id",
    description="referencelist-description",
    entries=[{
        "value": "referencelist-entry-value",
    }],
    syntax_type="REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING")
Copy
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.NewReferenceList(ctx, "example", &chronicle.ReferenceListArgs{
			Location:        pulumi.String("us"),
			Instance:        pulumi.String("00000000-0000-0000-0000-000000000000"),
			ReferenceListId: pulumi.String("reference_list_id"),
			Description:     pulumi.String("referencelist-description"),
			Entries: chronicle.ReferenceListEntryArray{
				&chronicle.ReferenceListEntryArgs{
					Value: pulumi.String("referencelist-entry-value"),
				},
			},
			SyntaxType: pulumi.String("REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var example = new Gcp.Chronicle.ReferenceList("example", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        ReferenceListId = "reference_list_id",
        Description = "referencelist-description",
        Entries = new[]
        {
            new Gcp.Chronicle.Inputs.ReferenceListEntryArgs
            {
                Value = "referencelist-entry-value",
            },
        },
        SyntaxType = "REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.ReferenceList;
import com.pulumi.gcp.chronicle.ReferenceListArgs;
import com.pulumi.gcp.chronicle.inputs.ReferenceListEntryArgs;
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 ReferenceList("example", ReferenceListArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .referenceListId("reference_list_id")
            .description("referencelist-description")
            .entries(ReferenceListEntryArgs.builder()
                .value("referencelist-entry-value")
                .build())
            .syntaxType("REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING")
            .build());

    }
}
Copy
resources:
  example:
    type: gcp:chronicle:ReferenceList
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      referenceListId: reference_list_id
      description: referencelist-description
      entries:
        - value: referencelist-entry-value
      syntaxType: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING
Copy

Create ReferenceList Resource

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

Constructor syntax

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

@overload
def ReferenceList(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  entries: Optional[Sequence[ReferenceListEntryArgs]] = None,
                  instance: Optional[str] = None,
                  location: Optional[str] = None,
                  reference_list_id: Optional[str] = None,
                  syntax_type: Optional[str] = None,
                  project: Optional[str] = None)
func NewReferenceList(ctx *Context, name string, args ReferenceListArgs, opts ...ResourceOption) (*ReferenceList, error)
public ReferenceList(string name, ReferenceListArgs args, CustomResourceOptions? opts = null)
public ReferenceList(String name, ReferenceListArgs args)
public ReferenceList(String name, ReferenceListArgs args, CustomResourceOptions options)
type: gcp:chronicle:ReferenceList
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ReferenceListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ReferenceListArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ReferenceListArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ReferenceListArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ReferenceListArgs
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 referenceListResource = new Gcp.Chronicle.ReferenceList("referenceListResource", new()
{
    Description = "string",
    Entries = new[]
    {
        new Gcp.Chronicle.Inputs.ReferenceListEntryArgs
        {
            Value = "string",
        },
    },
    Instance = "string",
    Location = "string",
    ReferenceListId = "string",
    SyntaxType = "string",
    Project = "string",
});
Copy
example, err := chronicle.NewReferenceList(ctx, "referenceListResource", &chronicle.ReferenceListArgs{
	Description: pulumi.String("string"),
	Entries: chronicle.ReferenceListEntryArray{
		&chronicle.ReferenceListEntryArgs{
			Value: pulumi.String("string"),
		},
	},
	Instance:        pulumi.String("string"),
	Location:        pulumi.String("string"),
	ReferenceListId: pulumi.String("string"),
	SyntaxType:      pulumi.String("string"),
	Project:         pulumi.String("string"),
})
Copy
var referenceListResource = new ReferenceList("referenceListResource", ReferenceListArgs.builder()
    .description("string")
    .entries(ReferenceListEntryArgs.builder()
        .value("string")
        .build())
    .instance("string")
    .location("string")
    .referenceListId("string")
    .syntaxType("string")
    .project("string")
    .build());
Copy
reference_list_resource = gcp.chronicle.ReferenceList("referenceListResource",
    description="string",
    entries=[{
        "value": "string",
    }],
    instance="string",
    location="string",
    reference_list_id="string",
    syntax_type="string",
    project="string")
Copy
const referenceListResource = new gcp.chronicle.ReferenceList("referenceListResource", {
    description: "string",
    entries: [{
        value: "string",
    }],
    instance: "string",
    location: "string",
    referenceListId: "string",
    syntaxType: "string",
    project: "string",
});
Copy
type: gcp:chronicle:ReferenceList
properties:
    description: string
    entries:
        - value: string
    instance: string
    location: string
    project: string
    referenceListId: string
    syntaxType: string
Copy

ReferenceList 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 ReferenceList resource accepts the following input properties:

Description This property is required. string
Required. A user-provided description of the reference list.
Entries This property is required. List<ReferenceListEntry>
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
Instance
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
Location
This property is required.
Changes to this property will trigger replacement.
string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
ReferenceListId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
SyntaxType This property is required. string
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
Project Changes to this property will trigger replacement. string
Description This property is required. string
Required. A user-provided description of the reference list.
Entries This property is required. []ReferenceListEntryArgs
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
Instance
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
Location
This property is required.
Changes to this property will trigger replacement.
string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
ReferenceListId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
SyntaxType This property is required. string
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
Project Changes to this property will trigger replacement. string
description This property is required. String
Required. A user-provided description of the reference list.
entries This property is required. List<ReferenceListEntry>
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
instance
This property is required.
Changes to this property will trigger replacement.
String
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location
This property is required.
Changes to this property will trigger replacement.
String
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
referenceListId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
syntaxType This property is required. String
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
project Changes to this property will trigger replacement. String
description This property is required. string
Required. A user-provided description of the reference list.
entries This property is required. ReferenceListEntry[]
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
instance
This property is required.
Changes to this property will trigger replacement.
string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location
This property is required.
Changes to this property will trigger replacement.
string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
referenceListId
This property is required.
Changes to this property will trigger replacement.
string
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
syntaxType This property is required. string
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
project Changes to this property will trigger replacement. string
description This property is required. str
Required. A user-provided description of the reference list.
entries This property is required. Sequence[ReferenceListEntryArgs]
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
instance
This property is required.
Changes to this property will trigger replacement.
str
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location
This property is required.
Changes to this property will trigger replacement.
str
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
reference_list_id
This property is required.
Changes to this property will trigger replacement.
str
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
syntax_type This property is required. str
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
project Changes to this property will trigger replacement. str
description This property is required. String
Required. A user-provided description of the reference list.
entries This property is required. List<Property Map>
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
instance
This property is required.
Changes to this property will trigger replacement.
String
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location
This property is required.
Changes to this property will trigger replacement.
String
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
referenceListId
This property is required.
Changes to this property will trigger replacement.
String
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
syntaxType This property is required. String
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
project Changes to this property will trigger replacement. String

Outputs

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

DisplayName string
Output only. The unique display name of the reference list.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
RevisionCreateTime string
Output only. The timestamp when the reference list was last updated.
RuleAssociationsCount int
Output only. The count of self-authored rules using the reference list.
Rules List<string>
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
ScopeInfos List<ReferenceListScopeInfo>
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
DisplayName string
Output only. The unique display name of the reference list.
Id string
The provider-assigned unique ID for this managed resource.
Name string
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
RevisionCreateTime string
Output only. The timestamp when the reference list was last updated.
RuleAssociationsCount int
Output only. The count of self-authored rules using the reference list.
Rules []string
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
ScopeInfos []ReferenceListScopeInfo
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
displayName String
Output only. The unique display name of the reference list.
id String
The provider-assigned unique ID for this managed resource.
name String
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
revisionCreateTime String
Output only. The timestamp when the reference list was last updated.
ruleAssociationsCount Integer
Output only. The count of self-authored rules using the reference list.
rules List<String>
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
scopeInfos List<ReferenceListScopeInfo>
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
displayName string
Output only. The unique display name of the reference list.
id string
The provider-assigned unique ID for this managed resource.
name string
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
revisionCreateTime string
Output only. The timestamp when the reference list was last updated.
ruleAssociationsCount number
Output only. The count of self-authored rules using the reference list.
rules string[]
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
scopeInfos ReferenceListScopeInfo[]
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
display_name str
Output only. The unique display name of the reference list.
id str
The provider-assigned unique ID for this managed resource.
name str
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
revision_create_time str
Output only. The timestamp when the reference list was last updated.
rule_associations_count int
Output only. The count of self-authored rules using the reference list.
rules Sequence[str]
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
scope_infos Sequence[ReferenceListScopeInfo]
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
displayName String
Output only. The unique display name of the reference list.
id String
The provider-assigned unique ID for this managed resource.
name String
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
revisionCreateTime String
Output only. The timestamp when the reference list was last updated.
ruleAssociationsCount Number
Output only. The count of self-authored rules using the reference list.
rules List<String>
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
scopeInfos List<Property Map>
ScopeInfo specifies the scope info of the reference list. Structure is documented below.

Look up Existing ReferenceList Resource

Get an existing ReferenceList 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?: ReferenceListState, opts?: CustomResourceOptions): ReferenceList
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        entries: Optional[Sequence[ReferenceListEntryArgs]] = None,
        instance: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        reference_list_id: Optional[str] = None,
        revision_create_time: Optional[str] = None,
        rule_associations_count: Optional[int] = None,
        rules: Optional[Sequence[str]] = None,
        scope_infos: Optional[Sequence[ReferenceListScopeInfoArgs]] = None,
        syntax_type: Optional[str] = None) -> ReferenceList
func GetReferenceList(ctx *Context, name string, id IDInput, state *ReferenceListState, opts ...ResourceOption) (*ReferenceList, error)
public static ReferenceList Get(string name, Input<string> id, ReferenceListState? state, CustomResourceOptions? opts = null)
public static ReferenceList get(String name, Output<String> id, ReferenceListState state, CustomResourceOptions options)
resources:  _:    type: gcp:chronicle:ReferenceList    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Required. A user-provided description of the reference list.
DisplayName string
Output only. The unique display name of the reference list.
Entries List<ReferenceListEntry>
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
Instance Changes to this property will trigger replacement. string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
Location Changes to this property will trigger replacement. string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
Name string
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
Project Changes to this property will trigger replacement. string
ReferenceListId Changes to this property will trigger replacement. string
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
RevisionCreateTime string
Output only. The timestamp when the reference list was last updated.
RuleAssociationsCount int
Output only. The count of self-authored rules using the reference list.
Rules List<string>
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
ScopeInfos List<ReferenceListScopeInfo>
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
SyntaxType string
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
Description string
Required. A user-provided description of the reference list.
DisplayName string
Output only. The unique display name of the reference list.
Entries []ReferenceListEntryArgs
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
Instance Changes to this property will trigger replacement. string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
Location Changes to this property will trigger replacement. string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
Name string
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
Project Changes to this property will trigger replacement. string
ReferenceListId Changes to this property will trigger replacement. string
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
RevisionCreateTime string
Output only. The timestamp when the reference list was last updated.
RuleAssociationsCount int
Output only. The count of self-authored rules using the reference list.
Rules []string
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
ScopeInfos []ReferenceListScopeInfoArgs
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
SyntaxType string
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
description String
Required. A user-provided description of the reference list.
displayName String
Output only. The unique display name of the reference list.
entries List<ReferenceListEntry>
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
instance Changes to this property will trigger replacement. String
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location Changes to this property will trigger replacement. String
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
name String
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
project Changes to this property will trigger replacement. String
referenceListId Changes to this property will trigger replacement. String
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
revisionCreateTime String
Output only. The timestamp when the reference list was last updated.
ruleAssociationsCount Integer
Output only. The count of self-authored rules using the reference list.
rules List<String>
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
scopeInfos List<ReferenceListScopeInfo>
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
syntaxType String
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
description string
Required. A user-provided description of the reference list.
displayName string
Output only. The unique display name of the reference list.
entries ReferenceListEntry[]
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
instance Changes to this property will trigger replacement. string
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location Changes to this property will trigger replacement. string
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
name string
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
project Changes to this property will trigger replacement. string
referenceListId Changes to this property will trigger replacement. string
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
revisionCreateTime string
Output only. The timestamp when the reference list was last updated.
ruleAssociationsCount number
Output only. The count of self-authored rules using the reference list.
rules string[]
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
scopeInfos ReferenceListScopeInfo[]
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
syntaxType string
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
description str
Required. A user-provided description of the reference list.
display_name str
Output only. The unique display name of the reference list.
entries Sequence[ReferenceListEntryArgs]
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
instance Changes to this property will trigger replacement. str
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location Changes to this property will trigger replacement. str
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
name str
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
project Changes to this property will trigger replacement. str
reference_list_id Changes to this property will trigger replacement. str
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
revision_create_time str
Output only. The timestamp when the reference list was last updated.
rule_associations_count int
Output only. The count of self-authored rules using the reference list.
rules Sequence[str]
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
scope_infos Sequence[ReferenceListScopeInfoArgs]
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
syntax_type str
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR
description String
Required. A user-provided description of the reference list.
displayName String
Output only. The unique display name of the reference list.
entries List<Property Map>
Required. The entries of the reference list. When listed, they are returned in the order that was specified at creation or update. The combined size of the values of the reference list may not exceed 6MB. This is returned only when the view is REFERENCE_LIST_VIEW_FULL. Structure is documented below.
instance Changes to this property will trigger replacement. String
The unique identifier for the Chronicle instance, which is the same as the customer ID.
location Changes to this property will trigger replacement. String
The location of the resource. This is the geographical region where the Chronicle instance resides, such as "us" or "europe-west2".
name String
Output only. The resource name of the reference list. Format: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}
project Changes to this property will trigger replacement. String
referenceListId Changes to this property will trigger replacement. String
Required. The ID to use for the reference list. This is also the display name for the reference list. It must satisfy the following requirements:

  • Starts with letter.
  • Contains only letters, numbers and underscore.
  • Has length < 256.
  • Must be unique.
revisionCreateTime String
Output only. The timestamp when the reference list was last updated.
ruleAssociationsCount Number
Output only. The count of self-authored rules using the reference list.
rules List<String>
Output only. The resource names for the associated self-authored Rules that use this reference list. This is returned only when the view is REFERENCE_LIST_VIEW_FULL.
scopeInfos List<Property Map>
ScopeInfo specifies the scope info of the reference list. Structure is documented below.
syntaxType String
Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR

Supporting Types

ReferenceListEntry
, ReferenceListEntryArgs

Value This property is required. string
Required. The value of the entry. Maximum length is 512 characters.


Value This property is required. string
Required. The value of the entry. Maximum length is 512 characters.


value This property is required. String
Required. The value of the entry. Maximum length is 512 characters.


value This property is required. string
Required. The value of the entry. Maximum length is 512 characters.


value This property is required. str
Required. The value of the entry. Maximum length is 512 characters.


value This property is required. String
Required. The value of the entry. Maximum length is 512 characters.


ReferenceListScopeInfo
, ReferenceListScopeInfoArgs

ReferenceListScope This property is required. ReferenceListScopeInfoReferenceListScope
ReferenceListScope specifies the list of scope names of the reference list. Structure is documented below.
ReferenceListScope This property is required. ReferenceListScopeInfoReferenceListScope
ReferenceListScope specifies the list of scope names of the reference list. Structure is documented below.
referenceListScope This property is required. ReferenceListScopeInfoReferenceListScope
ReferenceListScope specifies the list of scope names of the reference list. Structure is documented below.
referenceListScope This property is required. ReferenceListScopeInfoReferenceListScope
ReferenceListScope specifies the list of scope names of the reference list. Structure is documented below.
reference_list_scope This property is required. ReferenceListScopeInfoReferenceListScope
ReferenceListScope specifies the list of scope names of the reference list. Structure is documented below.
referenceListScope This property is required. Property Map
ReferenceListScope specifies the list of scope names of the reference list. Structure is documented below.

ReferenceListScopeInfoReferenceListScope
, ReferenceListScopeInfoReferenceListScopeArgs

ScopeNames List<string>
Optional. The list of scope names of the reference list. The scope names should be full resource names and should be of the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}".
ScopeNames []string
Optional. The list of scope names of the reference list. The scope names should be full resource names and should be of the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}".
scopeNames List<String>
Optional. The list of scope names of the reference list. The scope names should be full resource names and should be of the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}".
scopeNames string[]
Optional. The list of scope names of the reference list. The scope names should be full resource names and should be of the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}".
scope_names Sequence[str]
Optional. The list of scope names of the reference list. The scope names should be full resource names and should be of the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}".
scopeNames List<String>
Optional. The list of scope names of the reference list. The scope names should be full resource names and should be of the format: "projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{scope_name}".

Import

ReferenceList can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/instances/{{instance}}/referenceLists/{{reference_list_id}}

  • {{project}}/{{location}}/{{instance}}/{{reference_list_id}}

  • {{location}}/{{instance}}/{{reference_list_id}}

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

$ pulumi import gcp:chronicle/referenceList:ReferenceList default projects/{{project}}/locations/{{location}}/instances/{{instance}}/referenceLists/{{reference_list_id}}
Copy
$ pulumi import gcp:chronicle/referenceList:ReferenceList default {{project}}/{{location}}/{{instance}}/{{reference_list_id}}
Copy
$ pulumi import gcp:chronicle/referenceList:ReferenceList default {{location}}/{{instance}}/{{reference_list_id}}
Copy

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.