Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ClsIndex
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.ClsIndex

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to create a cls index.

    Example Usage

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

const exampleClsLogset = new tencentcloud.ClsLogset("exampleClsLogset", {
    logsetName: "tf_example",
    tags: {
        demo: "test",
    },
});
const exampleClsTopic = new tencentcloud.ClsTopic("exampleClsTopic", {
    topicName: "tf_example",
    logsetId: exampleClsLogset.clsLogsetId,
    autoSplit: false,
    maxSplitPartitions: 20,
    partitionCount: 1,
    period: 30,
    storageType: "hot",
    describes: "Test Demo.",
    hotPeriod: 10,
    tags: {
        test: "test",
    },
});
const tokenizerValue = "@&?|#()='\",;:<>[]{}";
const exampleClsIndex = new tencentcloud.ClsIndex("exampleClsIndex", {
    topicId: exampleClsTopic.clsTopicId,
    rule: {
        fullText: {
            caseSensitive: true,
            tokenizer: tokenizerValue,
            containZH: true,
        },
        keyValue: {
            caseSensitive: true,
            keyValues: [
                {
                    key: "hello",
                    value: {
                        containZH: true,
                        sqlFlag: true,
                        tokenizer: tokenizerValue,
                        type: "text",
                    },
                },
                {
                    key: "world",
                    value: {
                        containZH: true,
                        sqlFlag: true,
                        tokenizer: tokenizerValue,
                        type: "text",
                    },
                },
            ],
        },
        tag: {
            caseSensitive: true,
            keyValues: [{
                key: "terraform",
                value: {
                    containZH: true,
                    sqlFlag: true,
                    tokenizer: tokenizerValue,
                    type: "text",
                },
            }],
        },
        dynamicIndex: {
            status: true,
        },
    },
    status: true,
    includeInternalFields: true,
    metadataFlag: 1,
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example_cls_logset = tencentcloud.ClsLogset("exampleClsLogset",
    logset_name="tf_example",
    tags={
        "demo": "test",
    })
example_cls_topic = tencentcloud.ClsTopic("exampleClsTopic",
    topic_name="tf_example",
    logset_id=example_cls_logset.cls_logset_id,
    auto_split=False,
    max_split_partitions=20,
    partition_count=1,
    period=30,
    storage_type="hot",
    describes="Test Demo.",
    hot_period=10,
    tags={
        "test": "test",
    })
tokenizer_value = "@&?|#()='\",;:<>[]{}"
example_cls_index = tencentcloud.ClsIndex("exampleClsIndex",
    topic_id=example_cls_topic.cls_topic_id,
    rule={
        "full_text": {
            "case_sensitive": True,
            "tokenizer": tokenizer_value,
            "contain_zh": True,
        },
        "key_value": {
            "case_sensitive": True,
            "key_values": [
                {
                    "key": "hello",
                    "value": {
                        "contain_zh": True,
                        "sql_flag": True,
                        "tokenizer": tokenizer_value,
                        "type": "text",
                    },
                },
                {
                    "key": "world",
                    "value": {
                        "contain_zh": True,
                        "sql_flag": True,
                        "tokenizer": tokenizer_value,
                        "type": "text",
                    },
                },
            ],
        },
        "tag": {
            "case_sensitive": True,
            "key_values": [{
                "key": "terraform",
                "value": {
                    "contain_zh": True,
                    "sql_flag": True,
                    "tokenizer": tokenizer_value,
                    "type": "text",
                },
            }],
        },
        "dynamic_index": {
            "status": True,
        },
    },
    status=True,
    include_internal_fields=True,
    metadata_flag=1)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleClsLogset, err := tencentcloud.NewClsLogset(ctx, "exampleClsLogset", &tencentcloud.ClsLogsetArgs{
			LogsetName: pulumi.String("tf_example"),
			Tags: pulumi.StringMap{
				"demo": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		exampleClsTopic, err := tencentcloud.NewClsTopic(ctx, "exampleClsTopic", &tencentcloud.ClsTopicArgs{
			TopicName:          pulumi.String("tf_example"),
			LogsetId:           exampleClsLogset.ClsLogsetId,
			AutoSplit:          pulumi.Bool(false),
			MaxSplitPartitions: pulumi.Float64(20),
			PartitionCount:     pulumi.Float64(1),
			Period:             pulumi.Float64(30),
			StorageType:        pulumi.String("hot"),
			Describes:          pulumi.String("Test Demo."),
			HotPeriod:          pulumi.Float64(10),
			Tags: pulumi.StringMap{
				"test": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		tokenizerValue := "@&?|#()='\",;:<>[]{}"
		_, err = tencentcloud.NewClsIndex(ctx, "exampleClsIndex", &tencentcloud.ClsIndexArgs{
			TopicId: exampleClsTopic.ClsTopicId,
			Rule: &tencentcloud.ClsIndexRuleArgs{
				FullText: &tencentcloud.ClsIndexRuleFullTextArgs{
					CaseSensitive: pulumi.Bool(true),
					Tokenizer:     pulumi.String(tokenizerValue),
					ContainZH:     pulumi.Bool(true),
				},
				KeyValue: &tencentcloud.ClsIndexRuleKeyValueArgs{
					CaseSensitive: pulumi.Bool(true),
					KeyValues: tencentcloud.ClsIndexRuleKeyValueKeyValueArray{
						&tencentcloud.ClsIndexRuleKeyValueKeyValueArgs{
							Key: pulumi.String("hello"),
							Value: &tencentcloud.ClsIndexRuleKeyValueKeyValueValueArgs{
								ContainZH: pulumi.Bool(true),
								SqlFlag:   pulumi.Bool(true),
								Tokenizer: pulumi.String(tokenizerValue),
								Type:      pulumi.String("text"),
							},
						},
						&tencentcloud.ClsIndexRuleKeyValueKeyValueArgs{
							Key: pulumi.String("world"),
							Value: &tencentcloud.ClsIndexRuleKeyValueKeyValueValueArgs{
								ContainZH: pulumi.Bool(true),
								SqlFlag:   pulumi.Bool(true),
								Tokenizer: pulumi.String(tokenizerValue),
								Type:      pulumi.String("text"),
							},
						},
					},
				},
				Tag: &tencentcloud.ClsIndexRuleTagArgs{
					CaseSensitive: pulumi.Bool(true),
					KeyValues: tencentcloud.ClsIndexRuleTagKeyValueArray{
						&tencentcloud.ClsIndexRuleTagKeyValueArgs{
							Key: pulumi.String("terraform"),
							Value: &tencentcloud.ClsIndexRuleTagKeyValueValueArgs{
								ContainZH: pulumi.Bool(true),
								SqlFlag:   pulumi.Bool(true),
								Tokenizer: pulumi.String(tokenizerValue),
								Type:      pulumi.String("text"),
							},
						},
					},
				},
				DynamicIndex: &tencentcloud.ClsIndexRuleDynamicIndexArgs{
					Status: pulumi.Bool(true),
				},
			},
			Status:                pulumi.Bool(true),
			IncludeInternalFields: pulumi.Bool(true),
			MetadataFlag:          pulumi.Float64(1),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleClsLogset = new Tencentcloud.ClsLogset("exampleClsLogset", new()
    {
        LogsetName = "tf_example",
        Tags = 
        {
            { "demo", "test" },
        },
    });

    var exampleClsTopic = new Tencentcloud.ClsTopic("exampleClsTopic", new()
    {
        TopicName = "tf_example",
        LogsetId = exampleClsLogset.ClsLogsetId,
        AutoSplit = false,
        MaxSplitPartitions = 20,
        PartitionCount = 1,
        Period = 30,
        StorageType = "hot",
        Describes = "Test Demo.",
        HotPeriod = 10,
        Tags = 
        {
            { "test", "test" },
        },
    });

    var tokenizerValue = "@&?|#()='\",;:<>[]{}";

    var exampleClsIndex = new Tencentcloud.ClsIndex("exampleClsIndex", new()
    {
        TopicId = exampleClsTopic.ClsTopicId,
        Rule = new Tencentcloud.Inputs.ClsIndexRuleArgs
        {
            FullText = new Tencentcloud.Inputs.ClsIndexRuleFullTextArgs
            {
                CaseSensitive = true,
                Tokenizer = tokenizerValue,
                ContainZH = true,
            },
            KeyValue = new Tencentcloud.Inputs.ClsIndexRuleKeyValueArgs
            {
                CaseSensitive = true,
                KeyValues = new[]
                {
                    new Tencentcloud.Inputs.ClsIndexRuleKeyValueKeyValueArgs
                    {
                        Key = "hello",
                        Value = new Tencentcloud.Inputs.ClsIndexRuleKeyValueKeyValueValueArgs
                        {
                            ContainZH = true,
                            SqlFlag = true,
                            Tokenizer = tokenizerValue,
                            Type = "text",
                        },
                    },
                    new Tencentcloud.Inputs.ClsIndexRuleKeyValueKeyValueArgs
                    {
                        Key = "world",
                        Value = new Tencentcloud.Inputs.ClsIndexRuleKeyValueKeyValueValueArgs
                        {
                            ContainZH = true,
                            SqlFlag = true,
                            Tokenizer = tokenizerValue,
                            Type = "text",
                        },
                    },
                },
            },
            Tag = new Tencentcloud.Inputs.ClsIndexRuleTagArgs
            {
                CaseSensitive = true,
                KeyValues = new[]
                {
                    new Tencentcloud.Inputs.ClsIndexRuleTagKeyValueArgs
                    {
                        Key = "terraform",
                        Value = new Tencentcloud.Inputs.ClsIndexRuleTagKeyValueValueArgs
                        {
                            ContainZH = true,
                            SqlFlag = true,
                            Tokenizer = tokenizerValue,
                            Type = "text",
                        },
                    },
                },
            },
            DynamicIndex = new Tencentcloud.Inputs.ClsIndexRuleDynamicIndexArgs
            {
                Status = true,
            },
        },
        Status = true,
        IncludeInternalFields = true,
        MetadataFlag = 1,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClsLogset;
import com.pulumi.tencentcloud.ClsLogsetArgs;
import com.pulumi.tencentcloud.ClsTopic;
import com.pulumi.tencentcloud.ClsTopicArgs;
import com.pulumi.tencentcloud.ClsIndex;
import com.pulumi.tencentcloud.ClsIndexArgs;
import com.pulumi.tencentcloud.inputs.ClsIndexRuleArgs;
import com.pulumi.tencentcloud.inputs.ClsIndexRuleFullTextArgs;
import com.pulumi.tencentcloud.inputs.ClsIndexRuleKeyValueArgs;
import com.pulumi.tencentcloud.inputs.ClsIndexRuleTagArgs;
import com.pulumi.tencentcloud.inputs.ClsIndexRuleDynamicIndexArgs;
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 exampleClsLogset = new ClsLogset("exampleClsLogset", ClsLogsetArgs.builder()
            .logsetName("tf_example")
            .tags(Map.of("demo", "test"))
            .build());

        var exampleClsTopic = new ClsTopic("exampleClsTopic", ClsTopicArgs.builder()
            .topicName("tf_example")
            .logsetId(exampleClsLogset.clsLogsetId())
            .autoSplit(false)
            .maxSplitPartitions(20)
            .partitionCount(1)
            .period(30)
            .storageType("hot")
            .describes("Test Demo.")
            .hotPeriod(10)
            .tags(Map.of("test", "test"))
            .build());

        final var tokenizerValue = "@&?|#()='\",;:<>[]{}";

        var exampleClsIndex = new ClsIndex("exampleClsIndex", ClsIndexArgs.builder()
            .topicId(exampleClsTopic.clsTopicId())
            .rule(ClsIndexRuleArgs.builder()
                .fullText(ClsIndexRuleFullTextArgs.builder()
                    .caseSensitive(true)
                    .tokenizer(tokenizerValue)
                    .containZH(true)
                    .build())
                .keyValue(ClsIndexRuleKeyValueArgs.builder()
                    .caseSensitive(true)
                    .keyValues(                    
                        ClsIndexRuleKeyValueKeyValueArgs.builder()
                            .key("hello")
                            .value(ClsIndexRuleKeyValueKeyValueValueArgs.builder()
                                .containZH(true)
                                .sqlFlag(true)
                                .tokenizer(tokenizerValue)
                                .type("text")
                                .build())
                            .build(),
                        ClsIndexRuleKeyValueKeyValueArgs.builder()
                            .key("world")
                            .value(ClsIndexRuleKeyValueKeyValueValueArgs.builder()
                                .containZH(true)
                                .sqlFlag(true)
                                .tokenizer(tokenizerValue)
                                .type("text")
                                .build())
                            .build())
                    .build())
                .tag(ClsIndexRuleTagArgs.builder()
                    .caseSensitive(true)
                    .keyValues(ClsIndexRuleTagKeyValueArgs.builder()
                        .key("terraform")
                        .value(ClsIndexRuleTagKeyValueValueArgs.builder()
                            .containZH(true)
                            .sqlFlag(true)
                            .tokenizer(tokenizerValue)
                            .type("text")
                            .build())
                        .build())
                    .build())
                .dynamicIndex(ClsIndexRuleDynamicIndexArgs.builder()
                    .status(true)
                    .build())
                .build())
            .status(true)
            .includeInternalFields(true)
            .metadataFlag(1)
            .build());

    }
}

    resources:
  exampleClsLogset:
    type: tencentcloud:ClsLogset
    properties:
      logsetName: tf_example
      tags:
        demo: test
  exampleClsTopic:
    type: tencentcloud:ClsTopic
    properties:
      topicName: tf_example
      logsetId: ${exampleClsLogset.clsLogsetId}
      autoSplit: false
      maxSplitPartitions: 20
      partitionCount: 1
      period: 30
      storageType: hot
      describes: Test Demo.
      hotPeriod: 10
      tags:
        test: test
  exampleClsIndex:
    type: tencentcloud:ClsIndex
    properties:
      topicId: ${exampleClsTopic.clsTopicId}
      rule:
        fullText:
          caseSensitive: true
          tokenizer: ${tokenizerValue}
          containZH: true
        keyValue:
          caseSensitive: true
          keyValues:
            - key: hello
              value:
                containZH: true
                sqlFlag: true
                tokenizer: ${tokenizerValue}
                type: text
            - key: world
              value:
                containZH: true
                sqlFlag: true
                tokenizer: ${tokenizerValue}
                type: text
        tag:
          caseSensitive: true
          keyValues:
            - key: terraform
              value:
                containZH: true
                sqlFlag: true
                tokenizer: ${tokenizerValue}
                type: text
        dynamicIndex:
          status: true
      status: true
      includeInternalFields: true
      metadataFlag: 1
variables:
  tokenizerValue: '@&?|#()=''",;:<>[]{}'

    Create ClsIndex Resource

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

    Constructor syntax

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

@overload
def ClsIndex(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             topic_id: Optional[str] = None,
             cls_index_id: Optional[str] = None,
             include_internal_fields: Optional[bool] = None,
             metadata_flag: Optional[float] = None,
             rule: Optional[ClsIndexRuleArgs] = None,
             status: Optional[bool] = None)
    func NewClsIndex(ctx *Context, name string, args ClsIndexArgs, opts ...ResourceOption) (*ClsIndex, error)
    public ClsIndex(string name, ClsIndexArgs args, CustomResourceOptions? opts = null)
    public ClsIndex(String name, ClsIndexArgs args)
public ClsIndex(String name, ClsIndexArgs args, CustomResourceOptions options)

    type: tencentcloud:ClsIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClsIndexArgs
    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 ClsIndexArgs
    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 ClsIndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClsIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClsIndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    TopicId string
    Log topic ID.
    ClsIndexId string
    ID of the resource.
    IncludeInternalFields bool
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    MetadataFlag double
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    Rule ClsIndexRule
    Index rule.
    Status bool
    Whether to take effect. Default value: true.
    TopicId string
    Log topic ID.
    ClsIndexId string
    ID of the resource.
    IncludeInternalFields bool
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    MetadataFlag float64
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    Rule ClsIndexRuleArgs
    Index rule.
    Status bool
    Whether to take effect. Default value: true.
    topicId String
    Log topic ID.
    clsIndexId String
    ID of the resource.
    includeInternalFields Boolean
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    metadataFlag Double
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    rule ClsIndexRule
    Index rule.
    status Boolean
    Whether to take effect. Default value: true.
    topicId string
    Log topic ID.
    clsIndexId string
    ID of the resource.
    includeInternalFields boolean
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    metadataFlag number
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    rule ClsIndexRule
    Index rule.
    status boolean
    Whether to take effect. Default value: true.
    topic_id str
    Log topic ID.
    cls_index_id str
    ID of the resource.
    include_internal_fields bool
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    metadata_flag float
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    rule ClsIndexRuleArgs
    Index rule.
    status bool
    Whether to take effect. Default value: true.
    topicId String
    Log topic ID.
    clsIndexId String
    ID of the resource.
    includeInternalFields Boolean
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    metadataFlag Number
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    rule Property Map
    Index rule.
    status Boolean
    Whether to take effect. Default value: true.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ClsIndex Resource

    Get an existing ClsIndex 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?: ClsIndexState, opts?: CustomResourceOptions): ClsIndex
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cls_index_id: Optional[str] = None,
        include_internal_fields: Optional[bool] = None,
        metadata_flag: Optional[float] = None,
        rule: Optional[ClsIndexRuleArgs] = None,
        status: Optional[bool] = None,
        topic_id: Optional[str] = None) -> ClsIndex
    func GetClsIndex(ctx *Context, name string, id IDInput, state *ClsIndexState, opts ...ResourceOption) (*ClsIndex, error)
    public static ClsIndex Get(string name, Input<string> id, ClsIndexState? state, CustomResourceOptions? opts = null)
    public static ClsIndex get(String name, Output<String> id, ClsIndexState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ClsIndex    get:      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:
    ClsIndexId string
    ID of the resource.
    IncludeInternalFields bool
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    MetadataFlag double
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    Rule ClsIndexRule
    Index rule.
    Status bool
    Whether to take effect. Default value: true.
    TopicId string
    Log topic ID.
    ClsIndexId string
    ID of the resource.
    IncludeInternalFields bool
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    MetadataFlag float64
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    Rule ClsIndexRuleArgs
    Index rule.
    Status bool
    Whether to take effect. Default value: true.
    TopicId string
    Log topic ID.
    clsIndexId String
    ID of the resource.
    includeInternalFields Boolean
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    metadataFlag Double
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    rule ClsIndexRule
    Index rule.
    status Boolean
    Whether to take effect. Default value: true.
    topicId String
    Log topic ID.
    clsIndexId string
    ID of the resource.
    includeInternalFields boolean
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    metadataFlag number
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    rule ClsIndexRule
    Index rule.
    status boolean
    Whether to take effect. Default value: true.
    topicId string
    Log topic ID.
    cls_index_id str
    ID of the resource.
    include_internal_fields bool
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    metadata_flag float
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    rule ClsIndexRuleArgs
    Index rule.
    status bool
    Whether to take effect. Default value: true.
    topic_id str
    Log topic ID.
    clsIndexId String
    ID of the resource.
    includeInternalFields Boolean
    Internal field marker of full-text index. Default value: false. Valid value: false: excluding internal fields; true: including internal fields.
    metadataFlag Number
    Metadata flag. Default value: 0. Valid value: 0: full-text index (including the metadata field with key-value index enabled); 1: full-text index (including all metadata fields); 2: full-text index (excluding metadata fields)..
    rule Property Map
    Index rule.
    status Boolean
    Whether to take effect. Default value: true.
    topicId String
    Log topic ID.

    Supporting Types

    ClsIndexRule, ClsIndexRuleArgs

    DynamicIndex ClsIndexRuleDynamicIndex
    The key value index is automatically configured. If it is empty, it means that the function is not enabled.
    FullText ClsIndexRuleFullText
    Full-Text index configuration.
    KeyValue ClsIndexRuleKeyValue
    Key-Value index configuration.
    Tag ClsIndexRuleTag
    Metafield index configuration.
    DynamicIndex ClsIndexRuleDynamicIndex
    The key value index is automatically configured. If it is empty, it means that the function is not enabled.
    FullText ClsIndexRuleFullText
    Full-Text index configuration.
    KeyValue ClsIndexRuleKeyValue
    Key-Value index configuration.
    Tag ClsIndexRuleTag
    Metafield index configuration.
    dynamicIndex ClsIndexRuleDynamicIndex
    The key value index is automatically configured. If it is empty, it means that the function is not enabled.
    fullText ClsIndexRuleFullText
    Full-Text index configuration.
    keyValue ClsIndexRuleKeyValue
    Key-Value index configuration.
    tag ClsIndexRuleTag
    Metafield index configuration.
    dynamicIndex ClsIndexRuleDynamicIndex
    The key value index is automatically configured. If it is empty, it means that the function is not enabled.
    fullText ClsIndexRuleFullText
    Full-Text index configuration.
    keyValue ClsIndexRuleKeyValue
    Key-Value index configuration.
    tag ClsIndexRuleTag
    Metafield index configuration.
    dynamic_index ClsIndexRuleDynamicIndex
    The key value index is automatically configured. If it is empty, it means that the function is not enabled.
    full_text ClsIndexRuleFullText
    Full-Text index configuration.
    key_value ClsIndexRuleKeyValue
    Key-Value index configuration.
    tag ClsIndexRuleTag
    Metafield index configuration.
    dynamicIndex Property Map
    The key value index is automatically configured. If it is empty, it means that the function is not enabled.
    fullText Property Map
    Full-Text index configuration.
    keyValue Property Map
    Key-Value index configuration.
    tag Property Map
    Metafield index configuration.

    ClsIndexRuleDynamicIndex, ClsIndexRuleDynamicIndexArgs

    Status bool
    index automatic configuration switch.
    Status bool
    index automatic configuration switch.
    status Boolean
    index automatic configuration switch.
    status boolean
    index automatic configuration switch.
    status bool
    index automatic configuration switch.
    status Boolean
    index automatic configuration switch.

    ClsIndexRuleFullText, ClsIndexRuleFullTextArgs

    CaseSensitive bool
    Case sensitivity.
    ContainZH bool
    Whether Chinese characters are contained.
    Tokenizer string
    Full-Text index delimiter. Each character in the string represents a delimiter.
    CaseSensitive bool
    Case sensitivity.
    ContainZH bool
    Whether Chinese characters are contained.
    Tokenizer string
    Full-Text index delimiter. Each character in the string represents a delimiter.
    caseSensitive Boolean
    Case sensitivity.
    containZH Boolean
    Whether Chinese characters are contained.
    tokenizer String
    Full-Text index delimiter. Each character in the string represents a delimiter.
    caseSensitive boolean
    Case sensitivity.
    containZH boolean
    Whether Chinese characters are contained.
    tokenizer string
    Full-Text index delimiter. Each character in the string represents a delimiter.
    case_sensitive bool
    Case sensitivity.
    contain_zh bool
    Whether Chinese characters are contained.
    tokenizer str
    Full-Text index delimiter. Each character in the string represents a delimiter.
    caseSensitive Boolean
    Case sensitivity.
    containZH Boolean
    Whether Chinese characters are contained.
    tokenizer String
    Full-Text index delimiter. Each character in the string represents a delimiter.

    ClsIndexRuleKeyValue, ClsIndexRuleKeyValueArgs

    CaseSensitive bool
    Case sensitivity.
    KeyValues List<ClsIndexRuleKeyValueKeyValue>
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    CaseSensitive bool
    Case sensitivity.
    KeyValues []ClsIndexRuleKeyValueKeyValue
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    caseSensitive Boolean
    Case sensitivity.
    keyValues List<ClsIndexRuleKeyValueKeyValue>
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    caseSensitive boolean
    Case sensitivity.
    keyValues ClsIndexRuleKeyValueKeyValue[]
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    case_sensitive bool
    Case sensitivity.
    key_values Sequence[ClsIndexRuleKeyValueKeyValue]
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    caseSensitive Boolean
    Case sensitivity.
    keyValues List<Property Map>
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.

    ClsIndexRuleKeyValueKeyValue, ClsIndexRuleKeyValueKeyValueArgs

    Key string
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    Value ClsIndexRuleKeyValueKeyValueValue
    Field index description information.
    Key string
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    Value ClsIndexRuleKeyValueKeyValueValue
    Field index description information.
    key String
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    value ClsIndexRuleKeyValueKeyValueValue
    Field index description information.
    key string
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    value ClsIndexRuleKeyValueKeyValueValue
    Field index description information.
    key str
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    value ClsIndexRuleKeyValueKeyValueValue
    Field index description information.
    key String
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    value Property Map
    Field index description information.

    ClsIndexRuleKeyValueKeyValueValue, ClsIndexRuleKeyValueKeyValueValueArgs

    Type string
    Field type. Valid values: long, text, double.
    ContainZH bool
    Whether Chinese characters are contained.
    SqlFlag bool
    Whether the analysis feature is enabled for the field.
    Tokenizer string
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    Type string
    Field type. Valid values: long, text, double.
    ContainZH bool
    Whether Chinese characters are contained.
    SqlFlag bool
    Whether the analysis feature is enabled for the field.
    Tokenizer string
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    type String
    Field type. Valid values: long, text, double.
    containZH Boolean
    Whether Chinese characters are contained.
    sqlFlag Boolean
    Whether the analysis feature is enabled for the field.
    tokenizer String
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    type string
    Field type. Valid values: long, text, double.
    containZH boolean
    Whether Chinese characters are contained.
    sqlFlag boolean
    Whether the analysis feature is enabled for the field.
    tokenizer string
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    type str
    Field type. Valid values: long, text, double.
    contain_zh bool
    Whether Chinese characters are contained.
    sql_flag bool
    Whether the analysis feature is enabled for the field.
    tokenizer str
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    type String
    Field type. Valid values: long, text, double.
    containZH Boolean
    Whether Chinese characters are contained.
    sqlFlag Boolean
    Whether the analysis feature is enabled for the field.
    tokenizer String
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.

    ClsIndexRuleTag, ClsIndexRuleTagArgs

    CaseSensitive bool
    Case sensitivity.
    KeyValues List<ClsIndexRuleTagKeyValue>
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    CaseSensitive bool
    Case sensitivity.
    KeyValues []ClsIndexRuleTagKeyValue
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    caseSensitive Boolean
    Case sensitivity.
    keyValues List<ClsIndexRuleTagKeyValue>
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    caseSensitive boolean
    Case sensitivity.
    keyValues ClsIndexRuleTagKeyValue[]
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    case_sensitive bool
    Case sensitivity.
    key_values Sequence[ClsIndexRuleTagKeyValue]
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.
    caseSensitive Boolean
    Case sensitivity.
    keyValues List<Property Map>
    Key-Value pair information of the index to be created. Up to 100 key-value pairs can be configured.

    ClsIndexRuleTagKeyValue, ClsIndexRuleTagKeyValueArgs

    Key string
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    Value ClsIndexRuleTagKeyValueValue
    Field index description information.
    Key string
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    Value ClsIndexRuleTagKeyValueValue
    Field index description information.
    key String
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    value ClsIndexRuleTagKeyValueValue
    Field index description information.
    key string
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    value ClsIndexRuleTagKeyValueValue
    Field index description information.
    key str
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    value ClsIndexRuleTagKeyValueValue
    Field index description information.
    key String
    When a key value or metafield index needs to be configured for a field, the metafield Key does not need to be prefixed with TAG. and is consistent with the one when logs are uploaded. TAG. will be prefixed automatically for display in the console..
    value Property Map
    Field index description information.

    ClsIndexRuleTagKeyValueValue, ClsIndexRuleTagKeyValueValueArgs

    Type string
    Field type. Valid values: long, text, double.
    ContainZH bool
    Whether Chinese characters are contained.
    SqlFlag bool
    Whether the analysis feature is enabled for the field.
    Tokenizer string
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    Type string
    Field type. Valid values: long, text, double.
    ContainZH bool
    Whether Chinese characters are contained.
    SqlFlag bool
    Whether the analysis feature is enabled for the field.
    Tokenizer string
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    type String
    Field type. Valid values: long, text, double.
    containZH Boolean
    Whether Chinese characters are contained.
    sqlFlag Boolean
    Whether the analysis feature is enabled for the field.
    tokenizer String
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    type string
    Field type. Valid values: long, text, double.
    containZH boolean
    Whether Chinese characters are contained.
    sqlFlag boolean
    Whether the analysis feature is enabled for the field.
    tokenizer string
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    type str
    Field type. Valid values: long, text, double.
    contain_zh bool
    Whether Chinese characters are contained.
    sql_flag bool
    Whether the analysis feature is enabled for the field.
    tokenizer str
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.
    type String
    Field type. Valid values: long, text, double.
    containZH Boolean
    Whether Chinese characters are contained.
    sqlFlag Boolean
    Whether the analysis feature is enabled for the field.
    tokenizer String
    Field delimiter, which is meaningful only if the field type is text. Each character in the entered string represents a delimiter.

    Import

    cls cos index can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/clsIndex:ClsIndex example 0937e56f-4008-49d2-ad2d-69c52a9f11cc

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud