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

ReferenceListArgs

data class ReferenceListArgs(val description: Output<String>? = null, val entries: Output<List<ReferenceListEntryArgs>>? = null, val instance: Output<String>? = null, val location: Output<String>? = null, val project: Output<String>? = null, val referenceListId: Output<String>? = null, val syntaxType: Output<String>? = null) : ConvertibleToJava<ReferenceListArgs>

Reference lists are user-defined lists of values which users can use in multiple Rules. To get more information about ReferenceList, see:

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",
});
Content copied to clipboard
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")
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.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",
    });
});
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.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
	})
}
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.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());
    }
}
Content copied to clipboard
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
Content copied to clipboard

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

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, entries: Output<List<ReferenceListEntryArgs>>? = null, instance: Output<String>? = null, location: Output<String>? = null, project: Output<String>? = null, referenceListId: Output<String>? = null, syntaxType: Output<String>? = null)

Properties

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

Required. A user-provided description of the reference list.

Link copied to clipboard
val entries: Output<List<ReferenceListEntryArgs>>? = null

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.

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 project: Output<String>? = null
Link copied to clipboard
val referenceListId: Output<String>? = null

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:

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

Possible values: REFERENCE_LIST_SYNTAX_TYPE_PLAIN_TEXT_STRING REFERENCE_LIST_SYNTAX_TYPE_REGEX REFERENCE_LIST_SYNTAX_TYPE_CIDR

Functions

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