@piclemx/pulumi-opensearch
Version:
A Pulumi package for creating and managing Opensearch resources. Based on terraform-provider-opensearch: version v2.2.1
108 lines (107 loc) • 3.18 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an OpenSearch index template resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opensearch from "@piclemx/pulumi-opensearch";
*
* // Create an index template
* const template1 = new opensearch.IndexTemplate("template1", {body: `{
* "index_patterns": [
* "logs-2020-01-*"
* ],
* "template": {
* "aliases": {
* "my_logs": {}
* },
* "settings": {
* "index": {
* "number_of_shards": "2",
* "number_of_replicas": "1"
* }
* },
* "mappings": {
* "properties": {
* "timestamp": {
* "type": "date",
* "format": "yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||epoch_millis"
* },
* "value": {
* "type": "double"
* }
* }
* }
* }
* }
*
* `});
* ```
*
* ## Import
*
* ```sh
* $ pulumi import opensearch:index/indexTemplate:IndexTemplate template_1 template_1
* ```
*/
export declare class IndexTemplate extends pulumi.CustomResource {
/**
* Get an existing IndexTemplate 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?: IndexTemplateState, opts?: pulumi.CustomResourceOptions): IndexTemplate;
/**
* Returns true if the given object is an instance of IndexTemplate. 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 IndexTemplate;
/**
* 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 IndexTemplate 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: IndexTemplateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IndexTemplate resources.
*/
export interface IndexTemplateState {
/**
* 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 IndexTemplate resource.
*/
export interface IndexTemplateArgs {
/**
* The JSON body of the index template.
*/
body: pulumi.Input<string>;
/**
* The name of the index template.
*/
name?: pulumi.Input<string>;
}