|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "elasticstack_elasticsearch_index_alias Resource - terraform-provider-elasticstack" |
| 4 | +subcategory: "Index" |
| 5 | +description: |- |
| 6 | + Manages an Elasticsearch alias. See the alias documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html for more details. |
| 7 | +--- |
| 8 | + |
| 9 | +# elasticstack_elasticsearch_index_alias (Resource) |
| 10 | + |
| 11 | +Manages an Elasticsearch alias. See the [alias documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html) for more details. |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +<!-- schema generated by tfplugindocs --> |
| 16 | +## Schema |
| 17 | + |
| 18 | +### Required |
| 19 | + |
| 20 | +- `name` (String) The alias name. |
| 21 | + |
| 22 | +### Optional |
| 23 | + |
| 24 | +- `read_indices` (Attributes Set) Set of read indices for the alias. (see [below for nested schema](#nestedatt--read_indices)) |
| 25 | +- `write_index` (Attributes) The write index for the alias. Only one write index is allowed per alias. (see [below for nested schema](#nestedatt--write_index)) |
| 26 | + |
| 27 | +### Read-Only |
| 28 | + |
| 29 | +- `id` (String) Generated ID of the alias resource. |
| 30 | + |
| 31 | +<a id="nestedatt--read_indices"></a> |
| 32 | +### Nested Schema for `read_indices` |
| 33 | + |
| 34 | +Required: |
| 35 | + |
| 36 | +- `name` (String) Name of the read index. |
| 37 | + |
| 38 | +Optional: |
| 39 | + |
| 40 | +- `filter` (String) Query used to limit documents the alias can access. |
| 41 | +- `index_routing` (String) Value used to route indexing operations to a specific shard. |
| 42 | +- `is_hidden` (Boolean) If true, the alias is hidden. |
| 43 | +- `routing` (String) Value used to route indexing and search operations to a specific shard. |
| 44 | +- `search_routing` (String) Value used to route search operations to a specific shard. |
| 45 | + |
| 46 | + |
| 47 | +<a id="nestedatt--write_index"></a> |
| 48 | +### Nested Schema for `write_index` |
| 49 | + |
| 50 | +Required: |
| 51 | + |
| 52 | +- `name` (String) Name of the write index. |
| 53 | + |
| 54 | +Optional: |
| 55 | + |
| 56 | +- `filter` (String) Query used to limit documents the alias can access. |
| 57 | +- `index_routing` (String) Value used to route indexing operations to a specific shard. |
| 58 | +- `is_hidden` (Boolean) If true, the alias is hidden. |
| 59 | +- `routing` (String) Value used to route indexing and search operations to a specific shard. |
| 60 | +- `search_routing` (String) Value used to route search operations to a specific shard. |
0 commit comments