@volcengine/pulumi/tls/index_.d.ts

A Pulumi package for creating and managing volcengine cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Provides a resource to manage tls index
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as volcengine from "@volcengine/pulumi";
 *
 * const foo = new volcengine.tls.Index("foo", {
 *     keyValues: [
 *         {
 *             caseSensitive: true,
 *             delimiter: "!",
 *             includeChinese: false,
 *             indexAll: true,
 *             jsonKeys: [
 *                 {
 *                     key: "class",
 *                     valueType: "text",
 *                 },
 *                 {
 *                     key: "age",
 *                     valueType: "long",
 *                 },
 *             ],
 *             key: "k1",
 *             sqlFlag: true,
 *             valueType: "json",
 *         },
 *         {
 *             caseSensitive: true,
 *             delimiter: "!",
 *             includeChinese: false,
 *             key: "k5",
 *             sqlFlag: false,
 *             valueType: "text",
 *         },
 *     ],
 *     topicId: "227a8d0c-b85b-48df-bee1-0927a595****",
 *     userInnerKeyValues: [{
 *         caseSensitive: false,
 *         delimiter: ",:-/ ",
 *         includeChinese: false,
 *         jsonKeys: [
 *             {
 *                 key: "age",
 *                 valueType: "long",
 *             },
 *             {
 *                 key: "name",
 *                 valueType: "long",
 *             },
 *         ],
 *         key: "__content__",
 *         sqlFlag: false,
 *         valueType: "json",
 *     }],
 * });
 * ```
 *
 * ## Import
 *
 * Tls Index can be imported using the topic id, e.g.
 *
 * ```sh
 * $ pulumi import volcengine:tls/index:Index default index:edf051ed-3c46-49ba-9339-bea628fe****
 * ```
 */
export declare class Index extends pulumi.CustomResource {
    /**
     * Get an existing Index resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: IndexState, opts?: pulumi.CustomResourceOptions): Index;
    /**
     * Returns true if the given object is an instance of Index.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Index;
    /**
     * The create time of the tls index.
     */
    readonly createTime: pulumi.Output<string>;
    /**
     * The full text info of the tls index.
     */
    readonly fullText: pulumi.Output<outputs.tls.IndexFullText | undefined>;
    /**
     * The key value info of the tls index.
     */
    readonly keyValues: pulumi.Output<outputs.tls.IndexKeyValue[] | undefined>;
    /**
     * The modify time of the tls index.
     */
    readonly modifyTime: pulumi.Output<string>;
    /**
     * The topic id of the tls index.
     */
    readonly topicId: pulumi.Output<string>;
    /**
     * The reserved field index configuration of the tls index.
     */
    readonly userInnerKeyValues: pulumi.Output<outputs.tls.IndexUserInnerKeyValue[] | undefined>;
    /**
     * Create a Index resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: IndexArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Index resources.
 */
export interface IndexState {
    /**
     * The create time of the tls index.
     */
    createTime?: pulumi.Input<string>;
    /**
     * The full text info of the tls index.
     */
    fullText?: pulumi.Input<inputs.tls.IndexFullText>;
    /**
     * The key value info of the tls index.
     */
    keyValues?: pulumi.Input<pulumi.Input<inputs.tls.IndexKeyValue>[]>;
    /**
     * The modify time of the tls index.
     */
    modifyTime?: pulumi.Input<string>;
    /**
     * The topic id of the tls index.
     */
    topicId?: pulumi.Input<string>;
    /**
     * The reserved field index configuration of the tls index.
     */
    userInnerKeyValues?: pulumi.Input<pulumi.Input<inputs.tls.IndexUserInnerKeyValue>[]>;
}
/**
 * The set of arguments for constructing a Index resource.
 */
export interface IndexArgs {
    /**
     * The full text info of the tls index.
     */
    fullText?: pulumi.Input<inputs.tls.IndexFullText>;
    /**
     * The key value info of the tls index.
     */
    keyValues?: pulumi.Input<pulumi.Input<inputs.tls.IndexKeyValue>[]>;
    /**
     * The topic id of the tls index.
     */
    topicId: pulumi.Input<string>;
    /**
     * The reserved field index configuration of the tls index.
     */
    userInnerKeyValues?: pulumi.Input<pulumi.Input<inputs.tls.IndexUserInnerKeyValue>[]>;
}