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
<!--BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK-->
141
+
<!--BEGIN_TF_DOCS-->
142
142
## Requirements
143
143
144
144
| Name | Version |
@@ -188,31 +188,31 @@ No modules.
188
188
| <aname="input_access_policy_source_policy_documents"></a> [access\_policy\_source\_policy\_documents](#input\_access\_policy\_source\_policy\_documents)| List of IAM policy documents that are merged together into the exported document. Statements must have unique `sid`s |`list(string)`|`[]`| no |
189
189
| <aname="input_access_policy_statements"></a> [access\_policy\_statements](#input\_access\_policy\_statements)| A map of IAM policy [statements](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document#statement) for custom permission usage |`any`|`{}`| no |
190
190
| <aname="input_advanced_options"></a> [advanced\_options](#input\_advanced\_options)| Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing Terraform to want to recreate your Elasticsearch domain on every apply |`map(string)`|`{}`| no |
191
-
| <aname="input_advanced_security_options"></a> [advanced\_security\_options](#input\_advanced\_security\_options)| Configuration block for [fine-grained access control](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/fgac.html)|`any`| <pre>{<br> "anonymous_auth_enabled": false,<br> "enabled": true<br>}</pre> | no |
192
-
| <aname="input_auto_tune_options"></a> [auto\_tune\_options](#input\_auto\_tune\_options)| Configuration block for the Auto-Tune options of the domain |`any`| <pre>{<br> "desired_state": "ENABLED",<br> "rollback_on_disable": "NO_ROLLBACK"<br>}</pre> | no |
191
+
| <aname="input_advanced_security_options"></a> [advanced\_security\_options](#input\_advanced\_security\_options)| Configuration block for [fine-grained access control](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/fgac.html)|`any`| <pre>{<br/> "anonymous_auth_enabled": false,<br/> "enabled": true<br/>}</pre> | no |
192
+
| <aname="input_auto_tune_options"></a> [auto\_tune\_options](#input\_auto\_tune\_options)| Configuration block for the Auto-Tune options of the domain |`any`| <pre>{<br/> "desired_state": "ENABLED",<br/> "rollback_on_disable": "NO_ROLLBACK"<br/>}</pre> | no |
193
193
| <aname="input_cloudwatch_log_group_class"></a> [cloudwatch\_log\_group\_class](#input\_cloudwatch\_log\_group\_class)| Specified the log class of the log group. Possible values are: STANDARD or INFREQUENT\_ACCESS |`string`|`null`| no |
194
194
| <aname="input_cloudwatch_log_group_kms_key_id"></a> [cloudwatch\_log\_group\_kms\_key\_id](#input\_cloudwatch\_log\_group\_kms\_key\_id)| If a KMS Key ARN is set, this key will be used to encrypt the corresponding log group. Please be sure that the KMS Key has an appropriate key policy (https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)|`string`|`null`| no |
195
195
| <aname="input_cloudwatch_log_group_retention_in_days"></a> [cloudwatch\_log\_group\_retention\_in\_days](#input\_cloudwatch\_log\_group\_retention\_in\_days)| Number of days to retain log events |`number`|`60`| no |
196
196
| <aname="input_cloudwatch_log_group_skip_destroy"></a> [cloudwatch\_log\_group\_skip\_destroy](#input\_cloudwatch\_log\_group\_skip\_destroy)| Set to true if you do not wish the log group (and any logs it may contain) to be deleted at destroy time, and instead just remove the log group from the Terraform state |`bool`|`null`| no |
197
197
| <aname="input_cloudwatch_log_resource_policy_name"></a> [cloudwatch\_log\_resource\_policy\_name](#input\_cloudwatch\_log\_resource\_policy\_name)| Name of the resource policy for OpenSearch to log to CloudWatch |`string`|`null`| no |
198
-
| <aname="input_cluster_config"></a> [cluster\_config](#input\_cluster\_config)| Configuration block for the cluster of the domain |`any`| <pre>{<br> "dedicated_master_enabled": true<br>}</pre> | no |
198
+
| <aname="input_cluster_config"></a> [cluster\_config](#input\_cluster\_config)| Configuration block for the cluster of the domain |`any`| <pre>{<br/> "dedicated_master_enabled": true<br/>}</pre> | no |
199
199
| <aname="input_cognito_options"></a> [cognito\_options](#input\_cognito\_options)| Configuration block for authenticating Kibana with Cognito |`any`|`{}`| no |
200
200
| <aname="input_create"></a> [create](#input\_create)| Determines whether resources will be created (affects all resources) |`bool`|`true`| no |
201
201
| <aname="input_create_access_policy"></a> [create\_access\_policy](#input\_create\_access\_policy)| Determines whether an access policy will be created |`bool`|`true`| no |
202
202
| <aname="input_create_cloudwatch_log_groups"></a> [create\_cloudwatch\_log\_groups](#input\_create\_cloudwatch\_log\_groups)| Determines whether log groups are created |`bool`|`true`| no |
203
203
| <aname="input_create_cloudwatch_log_resource_policy"></a> [create\_cloudwatch\_log\_resource\_policy](#input\_create\_cloudwatch\_log\_resource\_policy)| Determines whether a resource policy will be created for OpenSearch to log to CloudWatch |`bool`|`true`| no |
204
204
| <aname="input_create_saml_options"></a> [create\_saml\_options](#input\_create\_saml\_options)| Determines whether SAML options will be created |`bool`|`false`| no |
205
205
| <aname="input_create_security_group"></a> [create\_security\_group](#input\_create\_security\_group)| Determines if a security group is created |`bool`|`true`| no |
206
-
| <aname="input_domain_endpoint_options"></a> [domain\_endpoint\_options](#input\_domain\_endpoint\_options)| Configuration block for domain endpoint HTTP(S) related options |`any`| <pre>{<br> "enforce_https": true,<br> "tls_security_policy": "Policy-Min-TLS-1-2-2019-07"<br>}</pre> | no |
206
+
| <aname="input_domain_endpoint_options"></a> [domain\_endpoint\_options](#input\_domain\_endpoint\_options)| Configuration block for domain endpoint HTTP(S) related options |`any`| <pre>{<br/> "enforce_https": true,<br/> "tls_security_policy": "Policy-Min-TLS-1-2-2019-07"<br/>}</pre> | no |
207
207
| <aname="input_domain_name"></a> [domain\_name](#input\_domain\_name)| Name of the domain |`string`|`""`| no |
208
-
| <aname="input_ebs_options"></a> [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`| <pre>{<br> "ebs_enabled": true,<br> "volume_size": 64,<br> "volume_type": "gp3"<br>}</pre> | no |
208
+
| <aname="input_ebs_options"></a> [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`| <pre>{<br/> "ebs_enabled": true,<br/> "volume_size": 64,<br/> "volume_type": "gp3"<br/>}</pre> | no |
209
209
| <aname="input_enable_access_policy"></a> [enable\_access\_policy](#input\_enable\_access\_policy)| Determines whether an access policy will be applied to the domain |`bool`|`true`| no |
210
-
| <aname="input_encrypt_at_rest"></a> [encrypt\_at\_rest](#input\_encrypt\_at\_rest)| Configuration block for encrypting at rest |`any`| <pre>{<br> "enabled": true<br>}</pre> | no |
210
+
| <aname="input_encrypt_at_rest"></a> [encrypt\_at\_rest](#input\_encrypt\_at\_rest)| Configuration block for encrypting at rest |`any`| <pre>{<br/> "enabled": true<br/>}</pre> | no |
211
211
| <aname="input_engine_version"></a> [engine\_version](#input\_engine\_version)| Version of the OpenSearch engine to use |`string`|`null`| no |
212
212
| <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
-
| <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
-
| <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 |
213
+
| <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
+
| <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 |
216
216
| <aname="input_outbound_connections"></a> [outbound\_connections](#input\_outbound\_connections)| Map of AWS OpenSearch outbound connections to create |`any`|`{}`| no |
217
217
| <aname="input_package_associations"></a> [package\_associations](#input\_package\_associations)| Map of package association IDs to associate with the domain |`map(string)`|`{}`| no |
218
218
| <aname="input_saml_options"></a> [saml\_options](#input\_saml\_options)| SAML authentication options for an AWS OpenSearch Domain |`any`|`{}`| no |
@@ -221,7 +221,7 @@ No modules.
221
221
| <aname="input_security_group_rules"></a> [security\_group\_rules](#input\_security\_group\_rules)| Security group ingress and egress rules to add to the security group created |`any`|`{}`| no |
222
222
| <aname="input_security_group_tags"></a> [security\_group\_tags](#input\_security\_group\_tags)| A map of additional tags to add to the security group created |`map(string)`|`{}`| no |
223
223
| <aname="input_security_group_use_name_prefix"></a> [security\_group\_use\_name\_prefix](#input\_security\_group\_use\_name\_prefix)| Determines whether the security group name (`security_group_name`) is used as a prefix |`bool`|`true`| no |
224
-
| <aname="input_software_update_options"></a> [software\_update\_options](#input\_software\_update\_options)| Software update options for the domain |`any`| <pre>{<br> "auto_software_update_enabled": true<br>}</pre> | no |
224
+
| <aname="input_software_update_options"></a> [software\_update\_options](#input\_software\_update\_options)| Software update options for the domain |`any`| <pre>{<br/> "auto_software_update_enabled": true<br/>}</pre> | no |
225
225
| <aname="input_tags"></a> [tags](#input\_tags)| A map of tags to add to all resources |`map(string)`|`{}`| no |
226
226
| <aname="input_timeouts"></a> [timeouts](#input\_timeouts)| Create and delete timeout configurations for the domain |`map(string)`|`{}`| no |
227
227
| <aname="input_vpc_endpoints"></a> [vpc\_endpoints](#input\_vpc\_endpoints)| Map of VPC endpoints to create for the domain |`any`|`{}`| no |
@@ -243,7 +243,7 @@ No modules.
243
243
| <aname="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn)| Amazon Resource Name (ARN) of the security group |
244
244
| <aname="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id)| ID of the security group |
245
245
| <aname="output_vpc_endpoints"></a> [vpc\_endpoints](#output\_vpc\_endpoints)| Map of VPC endpoints created and their attributes |
Copy file name to clipboardExpand all lines: examples/collection/README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ $ terraform apply
14
14
15
15
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
16
16
17
-
<!--BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK-->
17
+
<!--BEGIN_TF_DOCS-->
18
18
## Requirements
19
19
20
20
| Name | Version |
@@ -78,6 +78,6 @@ No inputs.
78
78
| <aname="output_opensearch_collection_public_lifecycle_policy_version"></a> [opensearch\_collection\_public\_lifecycle\_policy\_version](#output\_opensearch\_collection\_public\_lifecycle\_policy\_version)| The version of the lifecycle policy |
79
79
| <aname="output_opensearch_collection_public_network_policy"></a> [opensearch\_collection\_public\_network\_policy](#output\_opensearch\_collection\_public\_network\_policy)| The JSON policy document of the network policy |
80
80
| <aname="output_opensearch_collection_public_network_policy_version"></a> [opensearch\_collection\_public\_network\_policy\_version](#output\_opensearch\_collection\_public\_network\_policy\_version)| The version of the network policy |
81
-
<!--END OF PRE-COMMIT-TERRAFORM DOCS HOOK-->
81
+
<!--END_TF_DOCS-->
82
82
83
83
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-opensearch/blob/master/LICENSE).
Copy file name to clipboardExpand all lines: examples/complete/README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ $ terraform apply
20
20
21
21
Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
22
22
23
-
<!--BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK-->
23
+
<!--BEGIN_TF_DOCS-->
24
24
## Requirements
25
25
26
26
| Name | Version |
@@ -66,6 +66,6 @@ No inputs.
66
66
| <aname="output_security_group_arn"></a> [security\_group\_arn](#output\_security\_group\_arn)| Amazon Resource Name (ARN) of the security group |
67
67
| <aname="output_security_group_id"></a> [security\_group\_id](#output\_security\_group\_id)| ID of the security group |
68
68
| <aname="output_vpc_endpoints"></a> [vpc\_endpoints](#output\_vpc\_endpoints)| Map of VPC endpoints created and their attributes |
69
-
<!--END OF PRE-COMMIT-TERRAFORM DOCS HOOK-->
69
+
<!--END_TF_DOCS-->
70
70
71
71
Apache-2.0 Licensed. See [LICENSE](https://github.com/terraform-aws-modules/terraform-aws-opensearch/blob/master/LICENSE).
0 commit comments