You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/elasticsearch_alias.md
+32-6Lines changed: 32 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,18 +18,44 @@ Manages an Elasticsearch alias. See, https://www.elastic.co/guide/en/elasticsear
18
18
19
19
### Required
20
20
21
-
-`indices` (Set of String) A set of indices to which the alias should point.
22
21
-`name` (String) The alias name.
23
22
24
23
### Optional
25
24
25
+
-`read_indices` (Block Set) Set of read indices for the alias. (see [below for nested schema](#nestedblock--read_indices))
26
+
-`write_index` (Block, Optional) The write index for the alias. Only one write index is allowed per alias. (see [below for nested schema](#nestedblock--write_index))
27
+
28
+
### Read-Only
29
+
30
+
-`id` (String) Generated ID of the alias resource.
31
+
32
+
<aid="nestedblock--read_indices"></a>
33
+
### Nested Schema for `read_indices`
34
+
35
+
Required:
36
+
37
+
-`name` (String) Name of the read index.
38
+
39
+
Optional:
40
+
26
41
-`filter` (String) Query used to limit documents the alias can access.
27
-
-`index_routing` (String) Value used to route indexing operations to a specific shard. If specified, this overwrites the `routing` value for indexing operations.
42
+
-`index_routing` (String) Value used to route indexing operations to a specific shard.
28
43
-`is_hidden` (Boolean) If true, the alias is hidden.
29
-
-`is_write_index` (Boolean) If true, the index is the write index for the alias.
30
44
-`routing` (String) Value used to route indexing and search operations to a specific shard.
31
-
-`search_routing` (String) Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations.
45
+
-`search_routing` (String) Value used to route search operations to a specific shard.
32
46
33
-
### Read-Only
34
47
35
-
-`id` (String) Generated ID of the alias resource.
48
+
<aid="nestedblock--write_index"></a>
49
+
### Nested Schema for `write_index`
50
+
51
+
Required:
52
+
53
+
-`name` (String) Name of the write index.
54
+
55
+
Optional:
56
+
57
+
-`filter` (String) Query used to limit documents the alias can access.
58
+
-`index_routing` (String) Value used to route indexing operations to a specific shard.
59
+
-`is_hidden` (Boolean) If true, the alias is hidden.
60
+
-`routing` (String) Value used to route indexing and search operations to a specific shard.
61
+
-`search_routing` (String) Value used to route search operations to a specific shard.
0 commit comments