Skip to content

Commit 226308e

Browse files
committed
updates READMEs
1 parent 255a4cc commit 226308e

File tree

5 files changed

+1
-26
lines changed

5 files changed

+1
-26
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ No provider.
5050
|------|-------------|------|---------|:--------:|
5151
| domain\_name | The name to give to the OpenSearch domain | `string` | n/a | yes |
5252
| subnet\_ids | List of subnet IDs for the OpenSearch domain to be created in | `list(string)` | n/a | yes |
53-
| vpc\_id | The ID of the VPC in which to attach the security group | `string` | n/a | yes |
5453
| arn\_partition | The partition in which the resource is located. A partition is a group of AWS Regions.<br> Each AWS account is scoped to one partition.<br> The following are the supported partitions:<br> aws -AWS Regions<br> aws-cn - China Regions<br> aws-us-gov - AWS GovCloud (US) Regions | `string` | `"aws"` | no |
5554
| ebs\_enabled | Whether EBS volumes are attached to data nodes | `bool` | `true` | no |
5655
| ebs\_iops | The baseline I/O performance of EBS volumes attached to nodes.<br> Iops is only valid when volume type is io1 | `number` | `null` | no |

examples/logs/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ No requirements.
1818
| subnet\_cidr | n/a | `string` | n/a | yes |
1919
| vpc\_cidr | n/a | `string` | n/a | yes |
2020
| create\_new\_service\_role | Whether to create a new IAM service linked role for ES. This only needs to happen once per account. If false, linked\_service\_role is required | `bool` | `false` | no |
21-
| log\_retention\_in\_days | Specifies the number of days you want to retain log events.<br> Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653, and 0.<br> If you select 0, the events in the log group are always retained and never expire. | `number` | `0` | no |
2221
| log\_types | A list of log types that will be published to CloudWatch. Valid values are SEARCH\_SLOW\_LOGS, INDEX\_SLOW\_LOGS, ES\_APPLICATION\_LOGS and AUDIT\_LOGS. | `list(string)` | <pre>[<br> "ES_APPLICATION_LOGS",<br> "SEARCH_SLOW_LOGS",<br> "INDEX_SLOW_LOGS"<br>]</pre> | no |
2322
| tags | A map of tags to add to all resources created by this example. | `map(string)` | <pre>{<br> "Author": "Tamr",<br> "Environment": "Example"<br>}</pre> | no |
2423

modules/aws-es/README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,7 @@
11
# AWS OpenSearch Module
2-
This is a terraform module for a new OpenSearch domain on AWS.
2+
This is a Terraform module for a new OpenSearch domain on AWS.
33
This repo is laid out following the [terraform standard module structure](https://www.terraform.io/docs/modules/index.html#standard-module-structure).
44

5-
# Examples
6-
An inline example implementation of the module is implemented in the examples folder.
7-
This is the most basic example of what it would look like to use this module.
8-
9-
```
10-
module "tamr-es-cluster" {
11-
source = "git::https://github.com/Datatamer/terraform-aws-opensearch//modules/aws-es?ref=3.0.1"
12-
subnet_ids = ["subnet-id"]
13-
}
14-
```
15-
165
# Resources Created
176
This modules creates:
187
* a new security group with one or two attached rules (HTTP and/or HTTPS enabled)

modules/cloudwatch-logs/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,8 @@ No requirements.
1414

1515
| Name | Description | Type | Default | Required |
1616
|------|-------------|------|---------|:--------:|
17-
| domain\_name | The name to give to the ES domain | `string` | `"tamr-es-cluster"` | no |
1817
| log\_group\_name | The name of an existent CloudWatch Log Group that ElasticSearch will publish logs to | `string` | `""` | no |
19-
| log\_retention\_in\_days | Specifies the number of days you want to retain log events.<br> Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653, and 0.<br> If you select 0, the events in the log group are always retained and never expire. | `number` | `0` | no |
2018
| log\_types | A list of log types that will be published to CloudWatch. Valid values are SEARCH\_SLOW\_LOGS, INDEX\_SLOW\_LOGS, ES\_APPLICATION\_LOGS and AUDIT\_LOGS. | `list(string)` | <pre>[<br> "ES_APPLICATION_LOGS",<br> "SEARCH_SLOW_LOGS",<br> "INDEX_SLOW_LOGS"<br>]</pre> | no |
21-
| tags | A map of tags to add to CloudWatch resources. | `map(string)` | `{}` | no |
2219

2320
## Outputs
2421

modules/es-ports/README.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
11
# Tamr AWS OpenSearch Ports Module
22
This module returns a list of ports used by the OpenSearch Service on AWS.
33

4-
# Examples
5-
## Basic
6-
Inline example implementation of the module. This is the most basic example of what it would look like to use this module.
7-
```
8-
module "tamr-opensearch-ports" {
9-
source = "git::https://github.com/Datatamer/terraform-aws-opensearch//modules/es-ports?ref=3.0.0"
10-
}
11-
```
12-
134
# Resources Created
145
This modules creates no resources.
156

0 commit comments

Comments
 (0)