|
42 | 42 |
|
43 | 43 | [![Cloud Posse][logo]](https://cpco.io/homepage) |
44 | 44 |
|
45 | | -# terraform-aws-dynamodb-autoscaler [](https://g.codefresh.io/public/accounts/cloudposse/pipelines/5d1ce746c7657379f0d1e5fd) [](https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/releases/latest) [](https://slack.cloudposse.com) |
| 45 | +# terraform-aws-dynamodb-autoscaler [](https://github.com/cloudposse/terraform-aws-dynamodb-autoscaler/releases/latest) [](https://slack.cloudposse.com) |
46 | 46 |
|
47 | 47 |
|
48 | 48 | Terraform module to provision DynamoDB autoscaler. |
@@ -121,38 +121,52 @@ Available targets: |
121 | 121 | lint Lint terraform code |
122 | 122 |
|
123 | 123 | ``` |
| 124 | +## Requirements |
| 125 | + |
| 126 | +| Name | Version | |
| 127 | +|------|---------| |
| 128 | +| terraform | ~> 0.12.0 | |
| 129 | +| aws | ~> 2.0 | |
| 130 | +| null | ~> 2.0 | |
| 131 | + |
| 132 | +## Providers |
| 133 | + |
| 134 | +| Name | Version | |
| 135 | +|------|---------| |
| 136 | +| aws | ~> 2.0 | |
| 137 | + |
124 | 138 | ## Inputs |
125 | 139 |
|
126 | 140 | | Name | Description | Type | Default | Required | |
127 | | -|------|-------------|:----:|:-----:|:-----:| |
128 | | -| attributes | Additional attributes (e.g. `1`) | list(string) | `<list>` | no | |
129 | | -| autoscale_max_read_capacity | DynamoDB autoscaling max read capacity | number | `20` | no | |
130 | | -| autoscale_max_write_capacity | DynamoDB autoscaling max write capacity | number | `20` | no | |
131 | | -| autoscale_min_read_capacity | DynamoDB autoscaling min read capacity | number | `5` | no | |
132 | | -| autoscale_min_write_capacity | DynamoDB autoscaling min write capacity | number | `5` | no | |
133 | | -| autoscale_read_target | The target value for DynamoDB read autoscaling | number | `50` | no | |
134 | | -| autoscale_write_target | The target value for DynamoDB write autoscaling | number | `50` | no | |
135 | | -| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | string | `-` | no | |
136 | | -| dynamodb_indexes | List of DynamoDB indexes | list(string) | `<list>` | no | |
137 | | -| dynamodb_table_arn | DynamoDB table ARN | string | - | yes | |
138 | | -| dynamodb_table_name | DynamoDB table name | string | - | yes | |
139 | | -| enabled | Set to false to prevent the module from creating any resources | bool | `true` | no | |
140 | | -| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string | `` | no | |
141 | | -| name | Solution name, e.g. 'app' or 'jenkins' | string | `` | no | |
142 | | -| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | string | `` | no | |
143 | | -| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | string | `` | no | |
144 | | -| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | map(string) | `<map>` | no | |
| 141 | +|------|-------------|------|---------|:--------:| |
| 142 | +| attributes | Additional attributes (e.g. `1`) | `list(string)` | `[]` | no | |
| 143 | +| autoscale\_max\_read\_capacity | DynamoDB autoscaling max read capacity | `number` | `20` | no | |
| 144 | +| autoscale\_max\_write\_capacity | DynamoDB autoscaling max write capacity | `number` | `20` | no | |
| 145 | +| autoscale\_min\_read\_capacity | DynamoDB autoscaling min read capacity | `number` | `5` | no | |
| 146 | +| autoscale\_min\_write\_capacity | DynamoDB autoscaling min write capacity | `number` | `5` | no | |
| 147 | +| autoscale\_read\_target | The target value for DynamoDB read autoscaling | `number` | `50` | no | |
| 148 | +| autoscale\_write\_target | The target value for DynamoDB write autoscaling | `number` | `50` | no | |
| 149 | +| delimiter | Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes` | `string` | `"-"` | no | |
| 150 | +| dynamodb\_indexes | List of DynamoDB indexes | `list(string)` | `[]` | no | |
| 151 | +| dynamodb\_table\_arn | DynamoDB table ARN | `string` | n/a | yes | |
| 152 | +| dynamodb\_table\_name | DynamoDB table name | `string` | n/a | yes | |
| 153 | +| enabled | Set to false to prevent the module from creating any resources | `bool` | `true` | no | |
| 154 | +| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | `string` | `""` | no | |
| 155 | +| name | Solution name, e.g. 'app' or 'jenkins' | `string` | `""` | no | |
| 156 | +| namespace | Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp' | `string` | `""` | no | |
| 157 | +| stage | Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release' | `string` | `""` | no | |
| 158 | +| tags | Additional tags (e.g. `map('BusinessUnit','XYZ')` | `map(string)` | `{}` | no | |
145 | 159 |
|
146 | 160 | ## Outputs |
147 | 161 |
|
148 | 162 | | Name | Description | |
149 | 163 | |------|-------------| |
150 | | -| appautoscaling_read_target_id | Appautoscaling read target ID | |
151 | | -| appautoscaling_read_target_index_id | Appautoscaling read target index ID | |
152 | | -| appautoscaling_write_target_id | Appautoscaling write target ID | |
153 | | -| appautoscaling_write_target_index_id | Appautoscaling write target index ID | |
154 | | -| autoscaler_iam_role_arn | Autoscaler IAM Role ARN | |
155 | | -| autoscaler_iam_role_id | Autoscaler IAM Role ID | |
| 164 | +| appautoscaling\_read\_target\_id | Appautoscaling read target ID | |
| 165 | +| appautoscaling\_read\_target\_index\_id | Appautoscaling read target index ID | |
| 166 | +| appautoscaling\_write\_target\_id | Appautoscaling write target ID | |
| 167 | +| appautoscaling\_write\_target\_index\_id | Appautoscaling write target index ID | |
| 168 | +| autoscaler\_iam\_role\_arn | Autoscaler IAM Role ARN | |
| 169 | +| autoscaler\_iam\_role\_id | Autoscaler IAM Role ID | |
156 | 170 |
|
157 | 171 |
|
158 | 172 |
|
@@ -207,6 +221,10 @@ We deliver 10x the value for a fraction of the cost of a full-time engineer. Our |
207 | 221 |
|
208 | 222 | Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure. |
209 | 223 |
|
| 224 | +## Discourse Forums |
| 225 | + |
| 226 | +Participate in our [Discourse Forums][discourse]. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account. |
| 227 | + |
210 | 228 | ## Newsletter |
211 | 229 |
|
212 | 230 | Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover. |
@@ -320,6 +338,7 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply |
320 | 338 | [testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=testimonial |
321 | 339 | [office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=office_hours |
322 | 340 | [newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=newsletter |
| 341 | + [discourse]: https://ask.sweetops.com/?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=discourse |
323 | 342 | [email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=email |
324 | 343 | [commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=commercial_support |
325 | 344 | [we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-dynamodb-autoscaler&utm_content=we_love_open_source |
|
0 commit comments