Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Google Cloud (GCP)
  4. API Docs
  5. chronicle
  6. CaseTagDefinition
Viewing docs for Google Cloud v10.2.0
published on Tuesday, Oct 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.chronicle.CaseTagDefinition

gcp logo
Viewing docs for Google Cloud v10.2.0
published on Tuesday, Oct 20, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    A CaseTagDefinition is used to classify and tag cases based on criteria.

    To get more information about CaseTagDefinition, see:

    Example Usage

    Chronicle Casetagdefinition Basic

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

const example = new gcp.chronicle.CaseTagDefinition("example", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    displayName: "tag__89605",
    matchCriteria: "BY_VENDOR",
    value: "test_value",
    comparisonType: "EXACT",
    priority: 1,
    canBeCaseTitle: false,
});

    import pulumi
import pulumi_gcp as gcp

example = gcp.chronicle.CaseTagDefinition("example",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    display_name="tag__89605",
    match_criteria="BY_VENDOR",
    value="test_value",
    comparison_type="EXACT",
    priority=1,
    can_be_case_title=False)

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v10/go/gcp/chronicle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := chronicle.NewCaseTagDefinition(ctx, "example", &chronicle.CaseTagDefinitionArgs{
			Location:       pulumi.String("us"),
			Instance:       pulumi.String("00000000-0000-0000-0000-000000000000"),
			DisplayName:    pulumi.String("tag__89605"),
			MatchCriteria:  pulumi.String("BY_VENDOR"),
			Value:          pulumi.String("test_value"),
			ComparisonType: pulumi.String("EXACT"),
			Priority:       pulumi.Int(1),
			CanBeCaseTitle: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Gcp.Chronicle.CaseTagDefinition("example", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        DisplayName = "tag__89605",
        MatchCriteria = "BY_VENDOR",
        Value = "test_value",
        ComparisonType = "EXACT",
        Priority = 1,
        CanBeCaseTitle = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.CaseTagDefinition;
import com.pulumi.gcp.chronicle.CaseTagDefinitionArgs;
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 example = new CaseTagDefinition("example", CaseTagDefinitionArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .displayName("tag__89605")
            .matchCriteria("BY_VENDOR")
            .value("test_value")
            .comparisonType("EXACT")
            .priority(1)
            .canBeCaseTitle(false)
            .build());

    }
}

    resources:
  example:
    type: gcp:chronicle:CaseTagDefinition
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      displayName: tag__89605
      matchCriteria: BY_VENDOR
      value: test_value
      comparisonType: EXACT
      priority: 1
      canBeCaseTitle: false

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

resource "gcp_chronicle_case_tag_definition" "example" {
  lifecycle {
    create_before_destroy = true
  }
  location          = "us"
  instance          = "00000000-0000-0000-0000-000000000000"
  display_name      = "tag__89605"
  match_criteria    = "BY_VENDOR"
  value             = "test_value"
  comparison_type   = "EXACT"
  priority          = 1
  can_be_case_title = false
}

    Create CaseTagDefinition Resource

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

    Constructor syntax

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

@overload
def CaseTagDefinition(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      can_be_case_title: Optional[bool] = None,
                      comparison_type: Optional[str] = None,
                      display_name: Optional[str] = None,
                      instance: Optional[str] = None,
                      location: Optional[str] = None,
                      match_criteria: Optional[str] = None,
                      priority: Optional[int] = None,
                      value: Optional[str] = None,
                      deletion_policy: Optional[str] = None,
                      project: Optional[str] = None,
                      property_name: Optional[str] = None)
    func NewCaseTagDefinition(ctx *Context, name string, args CaseTagDefinitionArgs, opts ...ResourceOption) (*CaseTagDefinition, error)
    public CaseTagDefinition(string name, CaseTagDefinitionArgs args, CustomResourceOptions? opts = null)
    public CaseTagDefinition(String name, CaseTagDefinitionArgs args)
public CaseTagDefinition(String name, CaseTagDefinitionArgs args, CustomResourceOptions options)

    type: gcp:chronicle:CaseTagDefinition
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_chronicle_case_tag_definition" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CaseTagDefinitionArgs
    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 CaseTagDefinitionArgs
    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 CaseTagDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CaseTagDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CaseTagDefinitionArgs
    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 caseTagDefinitionResource = new Gcp.Chronicle.CaseTagDefinition("caseTagDefinitionResource", new()
{
    CanBeCaseTitle = false,
    ComparisonType = "string",
    DisplayName = "string",
    Instance = "string",
    Location = "string",
    MatchCriteria = "string",
    Priority = 0,
    Value = "string",
    DeletionPolicy = "string",
    Project = "string",
    PropertyName = "string",
});

    example, err := chronicle.NewCaseTagDefinition(ctx, "caseTagDefinitionResource", &chronicle.CaseTagDefinitionArgs{
	CanBeCaseTitle: pulumi.Bool(false),
	ComparisonType: pulumi.String("string"),
	DisplayName:    pulumi.String("string"),
	Instance:       pulumi.String("string"),
	Location:       pulumi.String("string"),
	MatchCriteria:  pulumi.String("string"),
	Priority:       pulumi.Int(0),
	Value:          pulumi.String("string"),
	DeletionPolicy: pulumi.String("string"),
	Project:        pulumi.String("string"),
	PropertyName:   pulumi.String("string"),
})

    resource "gcp_chronicle_case_tag_definition" "caseTagDefinitionResource" {
  lifecycle {
    create_before_destroy = true
  }
  can_be_case_title = false
  comparison_type   = "string"
  display_name      = "string"
  instance          = "string"
  location          = "string"
  match_criteria    = "string"
  priority          = 0
  value             = "string"
  deletion_policy   = "string"
  project           = "string"
  property_name     = "string"
}

    var caseTagDefinitionResource = new CaseTagDefinition("caseTagDefinitionResource", CaseTagDefinitionArgs.builder()
    .canBeCaseTitle(false)
    .comparisonType("string")
    .displayName("string")
    .instance("string")
    .location("string")
    .matchCriteria("string")
    .priority(0)
    .value("string")
    .deletionPolicy("string")
    .project("string")
    .propertyName("string")
    .build());

    case_tag_definition_resource = gcp.chronicle.CaseTagDefinition("caseTagDefinitionResource",
    can_be_case_title=False,
    comparison_type="string",
    display_name="string",
    instance="string",
    location="string",
    match_criteria="string",
    priority=0,
    value="string",
    deletion_policy="string",
    project="string",
    property_name="string")

    const caseTagDefinitionResource = new gcp.chronicle.CaseTagDefinition("caseTagDefinitionResource", {
    canBeCaseTitle: false,
    comparisonType: "string",
    displayName: "string",
    instance: "string",
    location: "string",
    matchCriteria: "string",
    priority: 0,
    value: "string",
    deletionPolicy: "string",
    project: "string",
    propertyName: "string",
});

    type: gcp:chronicle:CaseTagDefinition
properties:
    canBeCaseTitle: false
    comparisonType: string
    deletionPolicy: string
    displayName: string
    instance: string
    location: string
    matchCriteria: string
    priority: 0
    project: string
    propertyName: string
    value: string

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

    CanBeCaseTitle bool
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    ComparisonType string
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    DisplayName string
    This is the name of the tag that will be applied to the case.
    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.
    MatchCriteria string
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    Priority int
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    Value string
    Specific value to search in case - in addition to SearchIn property.
    DeletionPolicy 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.
    PropertyName string
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    CanBeCaseTitle bool
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    ComparisonType string
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    DisplayName string
    This is the name of the tag that will be applied to the case.
    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.
    MatchCriteria string
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    Priority int
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    Value string
    Specific value to search in case - in addition to SearchIn property.
    DeletionPolicy 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.
    PropertyName string
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    can_be_case_title bool
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    comparison_type string
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    display_name string
    This is the name of the tag that will be applied to the case.
    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.
    match_criteria string
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    priority number
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    value string
    Specific value to search in case - in addition to SearchIn property.
    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.
    property_name string
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    canBeCaseTitle Boolean
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    comparisonType String
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    displayName String
    This is the name of the tag that will be applied to the case.
    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.
    matchCriteria String
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    priority Integer
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    value String
    Specific value to search in case - in addition to SearchIn property.
    deletionPolicy 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.
    propertyName String
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    canBeCaseTitle boolean
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    comparisonType string
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    displayName string
    This is the name of the tag that will be applied to the case.
    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.
    matchCriteria string
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    priority number
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    value string
    Specific value to search in case - in addition to SearchIn property.
    deletionPolicy 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.
    propertyName string
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    can_be_case_title bool
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    comparison_type str
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    display_name str
    This is the name of the tag that will be applied to the case.
    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.
    match_criteria str
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    priority int
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    value str
    Specific value to search in case - in addition to SearchIn property.
    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.
    property_name str
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    canBeCaseTitle Boolean
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    comparisonType String
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    displayName String
    This is the name of the tag that will be applied to the case.
    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.
    matchCriteria String
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    priority Number
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    value String
    Specific value to search in case - in addition to SearchIn property.
    deletionPolicy 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.
    propertyName String
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.

    Outputs

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

    CaseTagDefinitionId string
    The unique identifier of the CaseTagDefinition.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    CaseTagDefinitionId string
    The unique identifier of the CaseTagDefinition.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    case_tag_definition_id string
    The unique identifier of the CaseTagDefinition.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    caseTagDefinitionId String
    The unique identifier of the CaseTagDefinition.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    caseTagDefinitionId string
    The unique identifier of the CaseTagDefinition.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    case_tag_definition_id str
    The unique identifier of the CaseTagDefinition.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    caseTagDefinitionId String
    The unique identifier of the CaseTagDefinition.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}

    Look up Existing CaseTagDefinition Resource

    Get an existing CaseTagDefinition 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?: CaseTagDefinitionState, opts?: CustomResourceOptions): CaseTagDefinition
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        can_be_case_title: Optional[bool] = None,
        case_tag_definition_id: Optional[str] = None,
        comparison_type: Optional[str] = None,
        deletion_policy: Optional[str] = None,
        display_name: Optional[str] = None,
        instance: Optional[str] = None,
        location: Optional[str] = None,
        match_criteria: Optional[str] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        project: Optional[str] = None,
        property_name: Optional[str] = None,
        value: Optional[str] = None) -> CaseTagDefinition
    func GetCaseTagDefinition(ctx *Context, name string, id IDInput, state *CaseTagDefinitionState, opts ...ResourceOption) (*CaseTagDefinition, error)
    public static CaseTagDefinition Get(string name, Input<string> id, CaseTagDefinitionState? state, CustomResourceOptions? opts = null)
    public static CaseTagDefinition get(String name, Output<String> id, CaseTagDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: gcp:chronicle:CaseTagDefinition    get:      id: ${id}
    import {
  to = gcp_chronicle_case_tag_definition.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.
    The following state arguments are supported:
    CanBeCaseTitle bool
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    CaseTagDefinitionId string
    The unique identifier of the CaseTagDefinition.
    ComparisonType string
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    DeletionPolicy 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.
    DisplayName string
    This is the name of the tag that will be applied to the case.
    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.
    MatchCriteria string
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    Name string
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    Priority int
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PropertyName string
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    Value string
    Specific value to search in case - in addition to SearchIn property.
    CanBeCaseTitle bool
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    CaseTagDefinitionId string
    The unique identifier of the CaseTagDefinition.
    ComparisonType string
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    DeletionPolicy 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.
    DisplayName string
    This is the name of the tag that will be applied to the case.
    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.
    MatchCriteria string
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    Name string
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    Priority int
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PropertyName string
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    Value string
    Specific value to search in case - in addition to SearchIn property.
    can_be_case_title bool
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    case_tag_definition_id string
    The unique identifier of the CaseTagDefinition.
    comparison_type string
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    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.
    display_name string
    This is the name of the tag that will be applied to the case.
    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.
    match_criteria string
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    name string
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    priority number
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    property_name string
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    value string
    Specific value to search in case - in addition to SearchIn property.
    canBeCaseTitle Boolean
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    caseTagDefinitionId String
    The unique identifier of the CaseTagDefinition.
    comparisonType String
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    deletionPolicy 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.
    displayName String
    This is the name of the tag that will be applied to the case.
    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.
    matchCriteria String
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    name String
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    priority Integer
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    propertyName String
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    value String
    Specific value to search in case - in addition to SearchIn property.
    canBeCaseTitle boolean
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    caseTagDefinitionId string
    The unique identifier of the CaseTagDefinition.
    comparisonType string
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    deletionPolicy 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.
    displayName string
    This is the name of the tag that will be applied to the case.
    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.
    matchCriteria string
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    name string
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    priority number
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    propertyName string
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    value string
    Specific value to search in case - in addition to SearchIn property.
    can_be_case_title bool
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    case_tag_definition_id str
    The unique identifier of the CaseTagDefinition.
    comparison_type str
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    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.
    display_name str
    This is the name of the tag that will be applied to the case.
    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.
    match_criteria str
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    name str
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    priority int
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    property_name str
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    value str
    Specific value to search in case - in addition to SearchIn property.
    canBeCaseTitle Boolean
    When checked, the tag will be assigned as the title of the case if it meets the conditions.
    caseTagDefinitionId String
    The unique identifier of the CaseTagDefinition.
    comparisonType String
    The type of comparison to be used when comparing the value to the case. Possible values are: EXACT, START_WITH, CONTAIN, ENDS_WITH.
    deletionPolicy 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.
    displayName String
    This is the name of the tag that will be applied to the case.
    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.
    matchCriteria String
    The criteria to match the case against. Possible values are: BY_VENDOR, BY_PRODUCT, BY_RULE_GENERATOR, BY_ENTITY_PROPERTY_NAME, DATA_DRIVEN, SYSTEM.
    name String
    Identifier. The unique name(ID) of the CaseTagDefinition. Format: projects/{project}/locations/{location}/instances/{instance}/caseTagDefinitions/{case_tag_definition_id}
    priority Number
    Note that Google Security Operations merges priority with other alerts and entities and events so that the priority here is not absolute.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    propertyName String
    Specific Entity property name to search in case. This is relevant only when a SearchIn of type BY_ENTITY_PROPERTY_NAME was chosen.
    value String
    Specific value to search in case - in addition to SearchIn property.

    Import

    CaseTagDefinition can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/instances/{{instance}}/caseTagDefinitions/{{case_tag_definition_id}}
    • {{project}}/{{location}}/{{instance}}/{{case_tag_definition_id}}
    • {{location}}/{{instance}}/{{case_tag_definition_id}}

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

    $ pulumi import gcp:chronicle/caseTagDefinition:CaseTagDefinition default projects/{{project}}/locations/{{location}}/instances/{{instance}}/caseTagDefinitions/{{case_tag_definition_id}}
$ pulumi import gcp:chronicle/caseTagDefinition:CaseTagDefinition default {{project}}/{{location}}/{{instance}}/{{case_tag_definition_id}}
$ pulumi import gcp:chronicle/caseTagDefinition:CaseTagDefinition default {{location}}/{{instance}}/{{case_tag_definition_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v10.2.0
    published on Tuesday, Oct 20, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial