diff --git a/README.md b/README.md index 6afbeea..5ec4f0c 100644 --- a/README.md +++ b/README.md @@ -47,10 +47,14 @@ module "opensearch" { } cluster_config = { - instance_count = 3 + multi_az_with_standby_enabled = false + dedicated_master_enabled = true + dedicated_master_count = 3 dedicated_master_type = "c6g.large.search" - instance_type = "r6g.large.search" + + instance_count = 3 + instance_type = "r6g.large.search" zone_awareness_config = { availability_zone_count = 3 @@ -124,6 +128,11 @@ module "opensearch" { } ] + # Off-peak window + off_peak_window_options = { + enabled = false + } + tags = { Terraform = "true" Environment = "dev" @@ -208,11 +217,11 @@ No modules. | [ebs\_options](#input\_ebs\_options) | Configuration block for EBS related options, may be required based on chosen [instance size](https://aws.amazon.com/elasticsearch-service/pricing/) | `any` |
{
"ebs_enabled": true,
"volume_size": 64,
"volume_type": "gp3"
}
| no | | [enable\_access\_policy](#input\_enable\_access\_policy) | Determines whether an access policy will be applied to the domain | `bool` | `true` | no | | [encrypt\_at\_rest](#input\_encrypt\_at\_rest) | Configuration block for encrypting at rest | `any` |
{
"enabled": true
}
| no | -| [engine\_version](#input\_engine\_version) | Version of the OpenSearch engine to use | `string` | `null` | no | +| [engine\_version](#input\_engine\_version) | Version of the OpenSearch engine to use. For example, `OpenSearch_2.11` or `Elasticsearch_7.9`. | `string` | `null` | no | | [ip\_address\_type](#input\_ip\_address\_type) | The IP address type for the endpoint. Valid values are ipv4 and dualstack | `string` | `null` | no | | [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` |
[
{
"log_type": "INDEX_SLOW_LOGS"
},
{
"log_type": "SEARCH_SLOW_LOGS"
}
]
| no | | [node\_to\_node\_encryption](#input\_node\_to\_node\_encryption) | Configuration block for node-to-node encryption options | `any` |
{
"enabled": true
}
| no | -| [off\_peak\_window\_options](#input\_off\_peak\_window\_options) | Configuration to add Off Peak update options | `any` |
{
"enabled": true,
"off_peak_window": {
"hours": 7
}
}
| no | +| [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` |
{
"enabled": true,
"off_peak_window": {
"hours": 7
}
}
| no | | [outbound\_connections](#input\_outbound\_connections) | Map of AWS OpenSearch outbound connections to create | `any` | `{}` | no | | [package\_associations](#input\_package\_associations) | Map of package association IDs to associate with the domain | `map(string)` | `{}` | no | | [saml\_options](#input\_saml\_options) | SAML authentication options for an AWS OpenSearch Domain | `any` | `{}` | no | diff --git a/examples/complete/main.tf b/examples/complete/main.tf index 1cef719..42e7160 100644 --- a/examples/complete/main.tf +++ b/examples/complete/main.tf @@ -59,10 +59,14 @@ module "opensearch" { } cluster_config = { - instance_count = 3 + multi_az_with_standby_enabled = false + + instance_count = 3 + instance_type = "r6g.large.search" + dedicated_master_enabled = true + dedicated_master_count = 3 dedicated_master_type = "c6g.large.search" - instance_type = "r6g.large.search" zone_awareness_config = { availability_zone_count = 3 @@ -150,6 +154,11 @@ module "opensearch" { } ] + # Off-peak window + off_peak_window_options = { + enabled = false + } + tags = local.tags }