@volcengine/pulumi
Version:
A Pulumi package for creating and managing volcengine cloud resources.
194 lines (193 loc) • 5.85 kB
TypeScript
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", {
* enableAutoIndex: true,
* fullText: {
* caseSensitive: false,
* delimiter: `, ;/
* \x09
* `,
* includeChinese: false,
* },
* keyValues: [{
* caseSensitive: true,
* delimiter: "!",
* includeChinese: false,
* indexAll: true,
* jsonKeys: [
* {
* key: "name",
* valueType: "text",
* },
* {
* key: "key",
* valueType: "long",
* },
* ],
* key: "k1",
* sqlFlag: true,
* valueType: "json",
* }],
* maxTextLen: 2048,
* topicId: "b600dc34-503f-42fc-8e32-953af55463d1",
* userInnerKeyValues: [{
* caseSensitive: false,
* delimiter: ",:-/ ",
* includeChinese: false,
* jsonKeys: [
* {
* key: "app",
* valueType: "long",
* },
* {
* key: "tag",
* 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>;
/**
* Whether to enable auto index.
*/
readonly enableAutoIndex: pulumi.Output<boolean | undefined>;
/**
* 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 max text length of the tls index.
*/
readonly maxTextLen: pulumi.Output<number | 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>;
/**
* Whether to enable auto index.
*/
enableAutoIndex?: pulumi.Input<boolean>;
/**
* 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 max text length of the tls index.
*/
maxTextLen?: pulumi.Input<number>;
/**
* 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 {
/**
* Whether to enable auto index.
*/
enableAutoIndex?: pulumi.Input<boolean>;
/**
* 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 max text length of the tls index.
*/
maxTextLen?: pulumi.Input<number>;
/**
* 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>[]>;
}