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
Copy file name to clipboardExpand all lines: README.md
+1-97Lines changed: 1 addition & 97 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,6 +53,7 @@ This module requires [AWS Provider](https://github.com/terraform-providers/terra
53
53
54
54
## Usage
55
55
56
+
56
57
For a complete example, see [examples/complete](examples/complete).
57
58
58
59
For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).
@@ -179,103 +180,6 @@ See [Terraform types and values](https://www.terraform.io/docs/configuration/exp
| <aname="input_additional_tag_map"></a> [additional\_tag\_map](#input\_additional\_tag\_map)| Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration. |`map(string)`|`{}`| no |
218
-
| <aname="input_attributes"></a> [attributes](#input\_attributes)| ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the `delimiter`<br/>and treated as a single ID element. |`list(string)`|`[]`| no |
219
-
| <aname="input_autoscale_max_read_capacity"></a> [autoscale\_max\_read\_capacity](#input\_autoscale\_max\_read\_capacity)| DynamoDB autoscaling max read capacity |`number`|`20`| no |
220
-
| <aname="input_autoscale_max_write_capacity"></a> [autoscale\_max\_write\_capacity](#input\_autoscale\_max\_write\_capacity)| DynamoDB autoscaling max write capacity |`number`|`20`| no |
221
-
| <aname="input_autoscale_min_read_capacity"></a> [autoscale\_min\_read\_capacity](#input\_autoscale\_min\_read\_capacity)| DynamoDB autoscaling min read capacity |`number`|`5`| no |
222
-
| <aname="input_autoscale_min_write_capacity"></a> [autoscale\_min\_write\_capacity](#input\_autoscale\_min\_write\_capacity)| DynamoDB autoscaling min write capacity |`number`|`5`| no |
223
-
| <aname="input_autoscale_read_target"></a> [autoscale\_read\_target](#input\_autoscale\_read\_target)| The target value (in %) for DynamoDB read autoscaling |`number`|`50`| no |
224
-
| <aname="input_autoscale_write_target"></a> [autoscale\_write\_target](#input\_autoscale\_write\_target)| The target value (in %) for DynamoDB write autoscaling |`number`|`50`| no |
225
-
| <aname="input_autoscaler_attributes"></a> [autoscaler\_attributes](#input\_autoscaler\_attributes)| Additional attributes for the autoscaler module |`list(string)`|`[]`| no |
226
-
| <aname="input_autoscaler_tags"></a> [autoscaler\_tags](#input\_autoscaler\_tags)| Additional resource tags for the autoscaler module |`map(string)`|`{}`| no |
227
-
| <aname="input_billing_mode"></a> [billing\_mode](#input\_billing\_mode)| DynamoDB Billing mode. Can be PROVISIONED or PAY\_PER\_REQUEST |`string`|`"PROVISIONED"`| no |
228
-
| <aname="input_context"></a> [context](#input\_context)| Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as `null` to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional\_tag\_map, which are merged. |`any`| <pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre> | no |
| <aname="input_delimiter"></a> [delimiter](#input\_delimiter)| Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. |`string`|`null`| no |
231
-
| <aname="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats)| Describe additional descriptors to be output in the `descriptors` output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>`{<br/> format = string<br/> labels = list(string)<br/>}`<br/>(Type is `any` so the map values can later be enhanced to provide additional options.)<br/>`format` is a Terraform format string to be passed to the `format()` function.<br/>`labels` is a list of labels, in order, to pass to `format()` function.<br/>Label values will be normalized before being passed to `format()` so they will be<br/>identical to how they appear in `id`.<br/>Default is `{}` (`descriptors` output will be empty). |`any`|`{}`| no |
232
-
| <aname="input_dynamodb_attributes"></a> [dynamodb\_attributes](#input\_dynamodb\_attributes)| Additional DynamoDB attributes in the form of a list of mapped values | <pre>list(object({<br/> name = string<br/> type = string<br/> }))</pre> |`[]`| no |
233
-
| <aname="input_enable_autoscaler"></a> [enable\_autoscaler](#input\_enable\_autoscaler)| Flag to enable/disable DynamoDB autoscaling |`bool`|`false`| no |
234
-
| <aname="input_enable_encryption"></a> [enable\_encryption](#input\_enable\_encryption)| Enable DynamoDB server-side encryption |`bool`|`true`| no |
235
-
| <aname="input_enable_point_in_time_recovery"></a> [enable\_point\_in\_time\_recovery](#input\_enable\_point\_in\_time\_recovery)| Enable DynamoDB point in time recovery |`bool`|`true`| no |
236
-
| <aname="input_enable_streams"></a> [enable\_streams](#input\_enable\_streams)| Enable DynamoDB streams |`bool`|`false`| no |
237
-
| <aname="input_enabled"></a> [enabled](#input\_enabled)| Set to false to prevent the module from creating any resources |`bool`|`null`| no |
238
-
| <aname="input_environment"></a> [environment](#input\_environment)| ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' |`string`|`null`| no |
239
-
| <aname="input_global_secondary_index_map"></a> [global\_secondary\_index\_map](#input\_global\_secondary\_index\_map)| Additional global secondary indexes in the form of a list of mapped values | <pre>list(object({<br/> hash_key = string<br/> name = string<br/> non_key_attributes = list(string)<br/> projection_type = string<br/> range_key = string<br/> read_capacity = number<br/> write_capacity = number<br/> }))</pre> |`[]`| no |
| <aname="input_hash_key_type"></a> [hash\_key\_type](#input\_hash\_key\_type)| Hash Key type, which must be a scalar type: `S`, `N`, or `B` for (S)tring, (N)umber or (B)inary data |`string`|`"S"`| no |
242
-
| <aname="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit)| Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`. |`number`|`null`| no |
243
-
| <aname="input_import_table"></a> [import\_table](#input\_import\_table)| Import Amazon S3 data into a new table. | <pre>object({<br/> # Valid values are GZIP, ZSTD and NONE<br/> input_compression_type = optional(string, null)<br/> # Valid values are CSV, DYNAMODB_JSON, and ION.<br/> input_format = string<br/> input_format_options = optional(object({<br/> csv = object({<br/> delimiter = string<br/> header_list = list(string)<br/> })<br/> }), null)<br/> s3_bucket_source = object({<br/> bucket = string<br/> bucket_owner = optional(string)<br/> key_prefix = optional(string)<br/> })<br/> })</pre> |`null`| no |
244
-
| <aname="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case)| Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`. |`string`|`null`| no |
245
-
| <aname="input_label_order"></a> [label\_order](#input\_label\_order)| The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. |`list(string)`|`null`| no |
246
-
| <aname="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case)| Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`. |`string`|`null`| no |
247
-
| <aname="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags)| Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>**Notes:**<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored. |`set(string)`| <pre>[<br/> "default"<br/>]</pre> | no |
248
-
| <aname="input_local_secondary_index_map"></a> [local\_secondary\_index\_map](#input\_local\_secondary\_index\_map)| Additional local secondary indexes in the form of a list of mapped values | <pre>list(object({<br/> name = string<br/> non_key_attributes = list(string)<br/> projection_type = string<br/> range_key = string<br/> }))</pre> |`[]`| no |
249
-
| <aname="input_name"></a> [name](#input\_name)| ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. |`string`|`null`| no |
250
-
| <aname="input_namespace"></a> [namespace](#input\_namespace)| ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique |`string`|`null`| no |
251
-
| <aname="input_range_key"></a> [range\_key](#input\_range\_key)| DynamoDB table Range Key |`string`|`""`| no |
252
-
| <aname="input_range_key_type"></a> [range\_key\_type](#input\_range\_key\_type)| Range Key type, which must be a scalar type: `S`, `N`, or `B` for (S)tring, (N)umber or (B)inary data |`string`|`"S"`| no |
253
-
| <aname="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars)| Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. |`string`|`null`| no |
254
-
| <aname="input_replicas"></a> [replicas](#input\_replicas)| List of regions to create replica |`list(string)`|`[]`| no |
255
-
| <aname="input_server_side_encryption_kms_key_arn"></a> [server\_side\_encryption\_kms\_key\_arn](#input\_server\_side\_encryption\_kms\_key\_arn)| The ARN of the CMK that should be used for the AWS KMS encryption. This attribute should only be specified if the key is different from the default DynamoDB CMK, alias/aws/dynamodb. |`string`|`null`| no |
256
-
| <aname="input_stage"></a> [stage](#input\_stage)| ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' |`string`|`null`| no |
257
-
| <aname="input_stream_view_type"></a> [stream\_view\_type](#input\_stream\_view\_type)| When an item in the table is modified, what information is written to the stream |`string`|`""`| no |
258
-
| <aname="input_table_class"></a> [table\_class](#input\_table\_class)| DynamoDB storage class of the table. Can be STANDARD or STANDARD\_INFREQUENT\_ACCESS |`string`|`"STANDARD"`| no |
259
-
| <aname="input_table_name"></a> [table\_name](#input\_table\_name)| Table name. If provided, the bucket will be created with this name instead of generating the name from the context |`string`|`null`| no |
260
-
| <aname="input_tags"></a> [tags](#input\_tags)| Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module. |`map(string)`|`{}`| no |
261
-
| <aname="input_tags_enabled"></a> [tags\_enabled](#input\_tags\_enabled)| Set to `false` to disable tagging. This can be helpful if you're managing tables on dynamodb-local with terraform as it doesn't support tagging. |`bool`|`true`| no |
262
-
| <aname="input_tenant"></a> [tenant](#input\_tenant)| ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for |`string`|`null`| no |
263
-
| <aname="input_ttl_attribute"></a> [ttl\_attribute](#input\_ttl\_attribute)| DynamoDB table TTL attribute |`string`|`"Expires"`| no |
264
-
| <aname="input_ttl_enabled"></a> [ttl\_enabled](#input\_ttl\_enabled)| Set to false to disable DynamoDB table TTL |`bool`|`true`| no |
265
-
266
-
## Outputs
267
-
268
-
| Name | Description |
269
-
|------|-------------|
270
-
| <aname="output_global_secondary_index_names"></a> [global\_secondary\_index\_names](#output\_global\_secondary\_index\_names)| DynamoDB secondary index names |
271
-
| <aname="output_local_secondary_index_names"></a> [local\_secondary\_index\_names](#output\_local\_secondary\_index\_names)| DynamoDB local index names |
0 commit comments