@piclemx/pulumi-opensearch
Version:
A Pulumi package for creating and managing Opensearch resources. Based on terraform-provider-opensearch: version v2.2.1
106 lines (105 loc) • 3.49 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an Composable index template resource. This resource uses the `/_index_template` endpoint of the API that is available since version 2.0.0. Use `opensearch.IndexTemplate` if you are using older versions or if you want to keep using legacy Index Templates.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opensearch from "@piclemx/pulumi-opensearch";
*
* const template1 = new opensearch.ComposableIndexTemplate("template1", {body: `{
* "index_patterns": ["te*", "bar*"],
* "template": {
* "settings": {
* "index": {
* "number_of_shards": "1"
* }
* },
* "mappings": {
* "properties": {
* "host_name": {
* "type": "keyword"
* },
* "created_at": {
* "type": "date",
* "format": "EEE MMM dd HH:mm:ss Z yyyy"
* }
* }
* },
* "aliases": {
* "mydata": { }
* }
* },
* "priority": 200,
* "version": 3
* }
*
* `});
* ```
*
* ## Import
*
* ```sh
* $ pulumi import opensearch:index/composableIndexTemplate:ComposableIndexTemplate template_1 template_1
* ```
*/
export declare class ComposableIndexTemplate extends pulumi.CustomResource {
/**
* Get an existing ComposableIndexTemplate 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?: ComposableIndexTemplateState, opts?: pulumi.CustomResourceOptions): ComposableIndexTemplate;
/**
* Returns true if the given object is an instance of ComposableIndexTemplate. 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 ComposableIndexTemplate;
/**
* The JSON body of the index template.
*/
readonly body: pulumi.Output<string>;
/**
* The name of the index template.
*/
readonly name: pulumi.Output<string>;
/**
* Create a ComposableIndexTemplate 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: ComposableIndexTemplateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ComposableIndexTemplate resources.
*/
export interface ComposableIndexTemplateState {
/**
* The JSON body of the index template.
*/
body?: pulumi.Input<string>;
/**
* The name of the index template.
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ComposableIndexTemplate resource.
*/
export interface ComposableIndexTemplateArgs {
/**
* The JSON body of the index template.
*/
body: pulumi.Input<string>;
/**
* The name of the index template.
*/
name?: pulumi.Input<string>;
}