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
docs: Add explanatory values and update config examples
* Included multi-AZ standby and dedicated master node settings for clarity.
* Provided a link to AWS documentation for additional context on off-peak windows.
* Sort cluster_config values
Copy file name to clipboardExpand all lines: README.md
+11-2Lines changed: 11 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,9 +47,13 @@ module "opensearch" {
47
47
}
48
48
49
49
cluster_config = {
50
-
instance_count = 3
50
+
multi_az_with_standby_enabled = false
51
+
51
52
dedicated_master_enabled = true
53
+
dedicated_master_count = 3
52
54
dedicated_master_type = "c6g.large.search"
55
+
56
+
instance_count = 3
53
57
instance_type = "r6g.large.search"
54
58
55
59
zone_awareness_config = {
@@ -124,6 +128,11 @@ module "opensearch" {
124
128
}
125
129
]
126
130
131
+
# Off-peak window
132
+
off_peak_window_options = {
133
+
enabled = false
134
+
}
135
+
127
136
tags = {
128
137
Terraform = "true"
129
138
Environment = "dev"
@@ -212,7 +221,7 @@ No modules.
212
221
| <aname="input_ip_address_type"></a> [ip\_address\_type](#input\_ip\_address\_type)| The IP address type for the endpoint. Valid values are ipv4 and dualstack |`string`|`null`| no |
213
222
| <aname="input_log_publishing_options"></a> [log\_publishing\_options](#input\_log\_publishing\_options)| Configuration block for publishing slow and application logs to CloudWatch Logs. This block can be declared multiple times, for each log\_type, within the same resource |`any`| <pre>[<br/> {<br/> "log_type": "INDEX_SLOW_LOGS"<br/> },<br/> {<br/> "log_type": "SEARCH_SLOW_LOGS"<br/> }<br/>]</pre> | no |
214
223
| <aname="input_node_to_node_encryption"></a> [node\_to\_node\_encryption](#input\_node\_to\_node\_encryption)| Configuration block for node-to-node encryption options |`any`| <pre>{<br/> "enabled": true<br/>}</pre> | no |
215
-
| <aname="input_off_peak_window_options"></a> [off\_peak\_window\_options](#input\_off\_peak\_window\_options)| Configuration to add Off Peak update options |`any`| <pre>{<br/> "enabled": true,<br/> "off_peak_window": {<br/> "hours": 7<br/> }<br/>}</pre> | no |
224
+
| <aname="input_off_peak_window_options"></a> [off\_peak\_window\_options](#input\_off\_peak\_window\_options)| Configuration to add Off Peak update options. OpenSearch Service uses off-peak window to schedule service software updates and Auto-Tune optimizations that require a blue/green deployment during comparatively lower traffic times, whenever possible. Refer to the [AWS documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/off-peak.html) for details.|`any`| <pre>{<br/> "enabled": true,<br/> "off_peak_window": {<br/> "hours": 7<br/> }<br/>}</pre> | no |
216
225
| <aname="input_outbound_connections"></a> [outbound\_connections](#input\_outbound\_connections)| Map of AWS OpenSearch outbound connections to create |`any`|`{}`| no |
217
226
| <aname="input_package_associations"></a> [package\_associations](#input\_package\_associations)| Map of package association IDs to associate with the domain |`map(string)`|`{}`| no |
218
227
| <aname="input_saml_options"></a> [saml\_options](#input\_saml\_options)| SAML authentication options for an AWS OpenSearch Domain |`any`|`{}`| no |
0 commit comments