Files
elasticsearch-js/docs/reference/api/IndicesIndexTemplate.md
2025-05-28 10:02:30 -05:00

1.9 KiB

IndicesIndexTemplate [interface-IndicesIndexTemplate]

Name Type Description
_meta Metadata Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.
allow_auto_create boolean  
composed_of Name[] An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
data_stream IndicesIndexTemplateDataStreamConfiguration If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a data_stream object.
deprecated boolean Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.
ignore_missing_component_templates Names A list of component template names that are allowed to be absent.
index_patterns Names Name of the index template.
priority long Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.
template IndicesIndexTemplateSummary Template to be applied. It may optionally include an aliases, mappings, or settings configuration.
version VersionNumber Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.