AWS DynamoDB Table Terraform module
Upstream version 5.5.0
0 controls from Registry requirements
Terraform Module Source
registry.compliance.tf/terraform-aws-modules/dynamodb-table/aws39 unique
| Name | Type | Default | Description |
|---|---|---|---|
| Optional | |||
attributes | list(map(string)) | [] | List of nested attribute definitions. Only required for hash_key and range_key attributes. Each attribute has two properties: name - (Required) The name of the attribute, type - (Required) Attribute type, which must be a scalar type: S, N, or B for (S)tring, (N)umber or (B)inary data |
autoscaling_defaults | map(string) | {...} | A map of default autoscaling settings |
autoscaling_enabled | bool | false | Whether or not to enable autoscaling. See note in README about this setting |
autoscaling_indexes | map(map(string)) | {} | A map of index autoscaling configurations. See example in examples/autoscaling |
autoscaling_read | map(string) | {} | A map of read autoscaling settings. `max_capacity` is the only required key. See example in examples/autoscaling |
autoscaling_write | map(string) | {} | A map of write autoscaling settings. `max_capacity` is the only required key. See example in examples/autoscaling |
billing_mode | string | "PAY_PER_REQUEST" | Controls how you are billed for read/write throughput and how you manage capacity. The valid values are PROVISIONED or PAY_PER_REQUEST |
create_table | bool | true | Controls if DynamoDB table and associated resources are created |
deletion_protection_enabled | bool | null | Enables deletion protection for table |
global_secondary_indexes | any | [] | Describe a GSI for the table; subject to the normal limits on the number of GSIs, projected attributes, etc. |
global_table_witness | object({...}) | null | Witness Region in a Multi-Region Strong Consistency deployment. Note This must be used alongside a single replica with consistency_mode set to STRONG. Other combinations will fail to provision |
hash_key | string | null | The attribute to use as the hash (partition) key. Must also be defined as an attribute |
ignore_changes_global_secondary_index | bool | false | Whether to ignore changes lifecycle to global secondary indices, useful for provisioned tables with scaling |
import_table | any | {} | Configurations for importing s3 data into a new table. |
local_secondary_indexes | any | [] | Describe an LSI on the table; these can only be allocated at creation so you cannot change this definition after you have created the resource. |
name | string | null | Name of the DynamoDB table |
on_demand_throughput | any | {} | Sets the maximum number of read and write units for the specified on-demand table |
point_in_time_recovery_enabled | bool | false | Whether to enable point-in-time recovery |
point_in_time_recovery_period_in_days | number | null | Number of preceding days for which continuous backups are taken and maintained. Default 35 |
range_key | string | null | The attribute to use as the range (sort) key. Must also be defined as an attribute |
read_capacity | number | null | The number of read units for this table. If the billing_mode is PROVISIONED, this field should be greater than 0 |
region | string | null | Region where this resource will be managed. Defaults to the Region set in the provider configuration |
replica_regions | any | [] | Region names for creating replicas for a global DynamoDB table. |
resource_policy | string | null | The JSON definition of the resource-based policy. |
restore_date_time | string | null | Time of the point-in-time recovery point to restore. |
restore_source_name | string | null | Name of the table to restore. Must match the name of an existing table. |
restore_source_table_arn | string | null | ARN of the source table to restore. Must be supplied for cross-region restores. |
restore_to_latest_time | bool | null | If set, restores table to the most recent point-in-time recovery point. |
server_side_encryption_enabled | bool | false | Whether or not to enable encryption at rest using an AWS managed KMS customer master key (CMK) |
server_side_encryption_kms_key_arn | string | null | 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. |
stream_enabled | bool | false | Indicates whether Streams are to be enabled (true) or disabled (false). |
stream_view_type | string | null | When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values are KEYS_ONLY, NEW_IMAGE, OLD_IMAGE, NEW_AND_OLD_IMAGES. |
table_class | string | null | The storage class of the table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS |
tags | map(string) | {} | A map of tags to add to all resources |
timeouts | map(string) | {...} | Updated Terraform resource management timeouts |
ttl_attribute_name | string | "" | The name of the table attribute to store the TTL timestamp in |
ttl_enabled | bool | false | Indicates whether ttl is enabled |
warm_throughput | any | {} | Sets the number of warm read and write units for the specified table |
write_capacity | number | null | The number of write units for this table. If the billing_mode is PROVISIONED, this field should be greater than 0 |