Merge pull request #11 from rackspace-infrastructure-automation/MPCSUPENG-867

John Titus · web-flow · commit 14e5974807b0 · 2020-01-29T10:23:51.000-06:00
HCL2\Terraform v0.12 conversion
diff --git a/.terraform-version b/.terraform-version
@@ -0,0 +1 @@
+0.12.17
diff --git a/README.md b/README.md
@@ -6,21 +6,21 @@ This module creates an AWS DynamoDB table.
 
 ```HCL
 module "basic" {
-  source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-dynamo/?ref=v0.0.3"
+  source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-dynamo/?ref=v0.12.0"
+
+  environment          = "Test"
+  hash_key             = "MyHashKey"
+  read_capacity_units  = 10
+  name                 = "myexampletable"
+  tags                 = local.tags
+  write_capacity_units = 5
 
   attributes = [
     {
       name = "TestHashKey"
       type = "S"
     },
   ]
-
-  environment          = "Test"
-  hash_key             = "MyHashKey"
-  read_capacity_units  = 10
-  table_name           = "myexampletable"
-  tags                 = "${local.tags}"
-  write_capacity_units = 5
 }
 ```
 
@@ -40,33 +40,50 @@ The input data was `["data1", "data2", "data3"]` and we can see that attributes
 
 The resolution at the moment is to edit the list in your map to match the order in the state file. This should result in a clean plan when no other changes are present.
 
-**References:**
+__References:__
 
 [global secondary index always recreated #3828](https://github.com/terraform-providers/terraform-provider-aws/issues/3828)
 
 [DynamoDB Non-Key Attributes Ordering #3807](https://github.com/terraform-providers/terraform-provider-aws/issues/3807)
 
+## Terraform 0.12 upgrade
+
+Several changes were required while adding terraform 0.12 compatibility.  The following changes should be  
+made when upgrading from a previous release to version 0.12.0 or higher.
+
+### Module variables
+
+The following module variables were updated to better meet current Rackspace style guides:
+
+- `table_name` -> `name`
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | >= 2.1.0 |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| attributes | List of nested attribute definitions. Only required for hash_key's (always) and range_key's (if used) attributes. Attributes have name and type. Type must be a scalar type: S, N, or B for (S)tring, (N)umber or (B)inary data. i.e. [{ name=<hash_key> type=<data_type>}]. Terraform documentation: [A note about attributes](https://www.terraform.io/docs/providers/aws/r/dynamodb_table.html#a-note-about-attributes) | list | n/a | yes |
-| enable\_pay\_per\_request | Controls how you are charged for read and write throughput and how you manage capacity. If True, DynamoDB charges you for the data reads and writes your application performs on your tables. You do not need to specify how much read and write throughput you expect your application to perform because DynamoDB instantly accommodates your workloads as they ramp up or down. [On-Demand Pricing](https://aws.amazon.com/dynamodb/pricing/on-demand/) If False, you specify the number of `read_capacity_units` and `write_capacity_units` per second that you expect your workload to require. [Provisioned Pricing](https://aws.amazon.com/dynamodb/pricing/provisioned/) | string | `"false"` | no |
-| enable\_ttl | Enable time to live on record. | string | `"false"` | no |
-| environment | Application environment for which this resource is being created. Preferred values are Development, Integration, PreProduction, Production, QA, Staging, or Test. | string | `"Development"` | no |
-| global\_secondary\_index\_maps | A list of maps for each [global secondary index (GSI)](https://www.terraform.io/docs/providers/aws/r/dynamodb_table.html#global_secondary_index-1). Please see [examples](./examples) for usage. | list | `<list>` | no |
-| hash\_key | **Forces new resource!** Must contain only alphanumberic characters, dash (-), underscore (_) or dot (.). Needs to be defined by type in attributes. | string | n/a | yes |
-| local\_secondary\_index\_maps | A list of maps for each [local secondary index (LSI)](https://www.terraform.io/docs/providers/aws/r/dynamodb_table.html#local_secondary_index-1). Please see [examples](./examples) for usage. | list | `<list>` | no |
-| point\_in\_time\_recovery | Enable point in time recovery for the table. | string | `"false"` | no |
-| range\_key | **Forces new resource!** RangeType PrimaryKey Name. If used, it will need to be defined by type in attributes | string | `""` | no |
-| read\_capacity\_units | Provisioned read throughput. Should be between 5 and 10000. Ignored if `enable_pay_per_request` is set to `true`. | string | `"5"` | no |
-| stream\_enabled | Enable the stream setting on the table. | string | `"false"` | no |
-| stream\_view\_type | If using `stream_enabled, you can specify a valid DynamoDB StreamViewType; must be one of: `KEYS_ONLY`, `NEW_IMAGE`. `OLD_IMAGE`, `NEW_AND_OLD_IMAGES` | string | `""` | no |
-| table\_encryption\_cmk | You may choose to use an [AWS Managed CMK](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) by setting this to `true`. Otherwise, server side table encryption defaults to an [AWS Owned CMK](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk). | string | `"false"` | no |
-| table\_name | The name of the table, this needs to be unique within a region. | string | n/a | yes |
-| tags | Custom tags to apply to all resources. | map | `<map>` | no |
-| ttl\_attribute | The name of the table attribute to store the TTL timestamp in | string | `""` | no |
-| write\_capacity\_units | Provisioned write throughput. Should be between 5 and 10000. Ignored if `enable_pay_per_request` is set to `true`. | string | `"10"` | no |
+|------|-------------|------|---------|:-----:|
+| attributes | List of nested attribute definitions. Only required for hash\_key's (always) and range\_key's (if used) attributes. Attributes have name and type. Type must be a scalar type: S, N, or B for (S)tring, (N)umber or (B)inary data. i.e. [{ name=<hash\_key> type=<data\_type>}]. Terraform documentation: [A note about attributes](https://www.terraform.io/docs/providers/aws/r/dynamodb_table.html#a-note-about-attributes) | `list(map(string))` | n/a | yes |
+| enable\_pay\_per\_request | Controls how you are charged for read and write throughput and how you manage capacity. If True, DynamoDB charges you for the data reads and writes your application performs on your tables. You do not need to specify how much read and write throughput you expect your application to perform because DynamoDB instantly accommodates your workloads as they ramp up or down. [On-Demand Pricing](https://aws.amazon.com/dynamodb/pricing/on-demand/) If False, you specify the number of `read_capacity_units` and `write_capacity_units` per second that you expect your workload to require. [Provisioned Pricing](https://aws.amazon.com/dynamodb/pricing/provisioned/) | `bool` | `false` | no |
+| enable\_ttl | Enable time to live on record. | `bool` | `false` | no |
+| environment | Application environment for which this resource is being created. Preferred values are Development, Integration, PreProduction, Production, QA, Staging, or Test. | `string` | `"Development"` | no |
+| global\_secondary\_index\_maps | A list of maps for each [global secondary index (GSI)](https://www.terraform.io/docs/providers/aws/r/dynamodb_table.html#global_secondary_index-1). Please see [examples](./examples) for usage. | `any` | `[]` | no |
+| hash\_key | \*\*Forces new resource!\*\* Must contain only alphanumberic characters, dash (-), underscore (\_) or dot (.). Needs to be defined by type in attributes. | `string` | n/a | yes |
+| local\_secondary\_index\_maps | A list of maps for each [local secondary index (LSI)](https://www.terraform.io/docs/providers/aws/r/dynamodb_table.html#local_secondary_index-1). Please see [examples](./examples) for usage. | `any` | `[]` | no |
+| name | The name of the table, this needs to be unique within a region. | `string` | n/a | yes |
+| point\_in\_time\_recovery | Enable point in time recovery for the table. | `bool` | `false` | no |
+| range\_key | \*\*Forces new resource!\*\* RangeType PrimaryKey Name. If used, it will need to be defined by type in attributes | `string` | `""` | no |
+| read\_capacity\_units | Provisioned read throughput. Should be between 5 and 10000. Ignored if `enable_pay_per_request` is set to `true`. | `number` | `5` | no |
+| stream\_enabled | Enable the stream setting on the table. | `bool` | `false` | no |
+| stream\_view\_type | If using `stream_enabled, you can specify a valid DynamoDB StreamViewType; must be one of: `KEYS\_ONLY`, `NEW\_IMAGE`. `OLD\_IMAGE`, `NEW\_AND\_OLD\_IMAGES | `string` | `""` | no |
+| table\_encryption\_cmk | You may choose to use an [AWS Managed CMK](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) by setting this to `true`. Otherwise, server side table encryption defaults to an [AWS Owned CMK](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk). | `bool` | `false` | no |
+| tags | Custom tags to apply to all resources. | `map(string)` | `{}` | no |
+| ttl\_attribute | The name of the table attribute to store the TTL timestamp in | `string` | `""` | no |
+| write\_capacity\_units | Provisioned write throughput. Should be between 5 and 10000. Ignored if `enable_pay_per_request` is set to `true`. | `number` | `10` | no |
 
 ## Outputs
 
diff --git a/examples/example.tf b/examples/example.tf
@@ -1,16 +1,22 @@
+terraform {
+  required_version = ">= 0.12"
+}
+
 provider "aws" {
-  version = "~> 1.2"
+  version = "~> 2.2"
   region  = "us-west-2"
 }
 
 module "dynamo_table_provisioned" {
-  source = "git@github.com/rackspace-infrastructure-automation/aws-terraform-dynamo//?ref=v0.0.6"
+  source = "git@github.com/rackspace-infrastructure-automation/aws-terraform-dynamo//?ref=v0.12.0"
 
-  table_name             = "<TableName>"
+  enable_pay_per_request = false
   hash_key               = "<HashKeyName>"
+  name                   = "<TableName>"
+  point_in_time_recovery = true
   range_key              = "<RangeKey>"
-  enable_pay_per_request = false
   read_capacity_units    = 5
+  table_encryption       = true
   write_capacity_units   = 10
 
   attributes = [
@@ -23,19 +29,17 @@ module "dynamo_table_provisioned" {
       type = "N"
     },
   ]
-
-  table_encryption = true
-
-  point_in_time_recovery = true
 }
 
 module "dynamo_table_pay_per_requst" {
-  source = "git@github.com/rackspace-infrastructure-automation/aws-terraform-dynamo//?ref=v0.0.6"
+  source = "git@github.com/rackspace-infrastructure-automation/aws-terraform-dynamo//?ref=v0.12.0"
 
-  table_name             = "<TableName>"
+  enable_pay_per_request = true
   hash_key               = "<HashKeyName>"
+  name                   = "<TableName>"
+  point_in_time_recovery = true
   range_key              = "<RangeKey>"
-  enable_pay_per_request = true
+  table_encryption       = true
 
   attributes = [
     {
@@ -47,8 +51,5 @@ module "dynamo_table_pay_per_requst" {
       type = "N"
     },
   ]
-
-  table_encryption = true
-
-  point_in_time_recovery = true
 }
+
diff --git a/main.tf b/main.tf
@@ -7,21 +7,21 @@
  *
  * ```HCL
  * module "basic" {
- *   source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-dynamo/?ref=v0.0.3"
+ *   source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-dynamo/?ref=v0.12.0"
+ *
+ *   environment          = "Test"
+ *   hash_key             = "MyHashKey"
+ *   read_capacity_units  = 10
+ *   name                 = "myexampletable"
+ *   tags                 = local.tags
+ *   write_capacity_units = 5
  *
  *   attributes = [
  *     {
  *       name = "TestHashKey"
  *       type = "S"
  *     },
  *   ]
- *
- *   environment          = "Test"
- *   hash_key             = "MyHashKey"
- *   read_capacity_units  = 10
- *   table_name           = "myexampletable"
- *   tags                 = "${local.tags}"
- *   write_capacity_units = 5
  * }
  * ```
  *
@@ -41,50 +41,97 @@
  *
  * The resolution at the moment is to edit the list in your map to match the order in the state file. This should result in a clean plan when no other changes are present.
  *
- * **References:**
+ * __References:__
  *
  * [global secondary index always recreated #3828](https://github.com/terraform-providers/terraform-provider-aws/issues/3828)
  *
  * [DynamoDB Non-Key Attributes Ordering #3807](https://github.com/terraform-providers/terraform-provider-aws/issues/3807)
+ *
+ * ## Terraform 0.12 upgrade
+ *
+ * Several changes were required while adding terraform 0.12 compatibility.  The following changes should be
+ * made when upgrading from a previous release to version 0.12.0 or higher.
+ *
+ * ### Module variables
+ *
+ * The following module variables were updated to better meet current Rackspace style guides:
+ *
+ * - `table_name` -> `name`
+ *
  */
 
+terraform {
+  required_version = ">= 0.12"
+
+  required_providers {
+    aws = ">= 2.1.0"
+  }
+}
+
 locals {
-  tags {
-    Environment     = "${var.environment}"
-    Name            = "${var.table_name}"
+  tags = {
+    Environment     = var.environment
+    Name            = var.name
     ServiceProvider = "Rackspace"
   }
 }
 
 resource "aws_dynamodb_table" "table" {
-  billing_mode     = "${var.enable_pay_per_request ? "PAY_PER_REQUEST" : "PROVISIONED" }"
-  hash_key         = "${var.hash_key}"
-  name             = "${var.table_name}"
-  range_key        = "${var.range_key}"
-  read_capacity    = "${var.enable_pay_per_request ? 0 : var.read_capacity_units}"
-  stream_enabled   = "${var.stream_enabled}"
-  stream_view_type = "${var.stream_enabled ? var.stream_view_type : "" }"
-  write_capacity   = "${var.enable_pay_per_request ? 0 : var.write_capacity_units}"
+  billing_mode     = var.enable_pay_per_request ? "PAY_PER_REQUEST" : "PROVISIONED"
+  hash_key         = var.hash_key
+  name             = var.name
+  range_key        = var.range_key
+  read_capacity    = var.enable_pay_per_request ? 0 : var.read_capacity_units
+  stream_enabled   = var.stream_enabled
+  stream_view_type = var.stream_enabled ? var.stream_view_type : ""
+  tags             = merge(local.tags, var.tags)
+  write_capacity   = var.enable_pay_per_request ? 0 : var.write_capacity_units
+
+  dynamic "attribute" {
+    for_each = var.attributes
+
+    content {
+      name = attribute.value.name
+      type = attribute.value.type
+    }
+  }
 
-  attribute              = "${var.attributes}"
-  global_secondary_index = "${var.global_secondary_index_maps}"
-  local_secondary_index  = "${var.local_secondary_index_maps}"
+  dynamic "global_secondary_index" {
+    for_each = var.global_secondary_index_maps
+
+    content {
+      hash_key           = global_secondary_index.value.hash_key
+      name               = global_secondary_index.value.name
+      non_key_attributes = lookup(global_secondary_index.value, "non_key_attributes", null)
+      projection_type    = global_secondary_index.value.projection_type
+      range_key          = lookup(global_secondary_index.value, "range_key", null)
+      read_capacity      = lookup(global_secondary_index.value, "read_capacity", null)
+      write_capacity     = lookup(global_secondary_index.value, "write_capacity", null)
+    }
+  }
+
+  dynamic "local_secondary_index" {
+    for_each = var.local_secondary_index_maps
+
+    content {
+      name               = local_secondary_index.value.name
+      non_key_attributes = lookup(local_secondary_index.value, "non_key_attributes", null)
+      projection_type    = local_secondary_index.value.projection_type
+      range_key          = local_secondary_index.value.range_key
+    }
+  }
 
   point_in_time_recovery {
-    enabled = "${var.point_in_time_recovery}"
+    enabled = var.point_in_time_recovery
   }
 
   server_side_encryption {
-    enabled = "${var.table_encryption_cmk}"
+    enabled = var.table_encryption_cmk
   }
 
   ttl {
-    enabled        = "${var.enable_ttl}"
-    attribute_name = "${var.ttl_attribute}"
+    enabled        = var.enable_ttl
+    attribute_name = var.ttl_attribute
   }
-
-  tags = "${merge(
-    local.tags,
-    var.tags
-  )}"
 }
+
diff --git a/outputs.tf b/outputs.tf
@@ -1,14 +1,15 @@
 output "stream_arn" {
   description = "ARN for the stream if `stream_enabled` was set to `true`, otherwise returns a string of \"null\"."
-  value       = "${var.stream_enabled == "true" ? aws_dynamodb_table.table.stream_arn : "null" }"
+  value       = var.stream_enabled == "true" ? aws_dynamodb_table.table.stream_arn : "null"
 }
 
 output "table_arn" {
   description = "Table ARN"
-  value       = "${aws_dynamodb_table.table.arn}"
+  value       = aws_dynamodb_table.table.arn
 }
 
 output "table_name" {
   description = "Table Name"
-  value       = "${aws_dynamodb_table.table.id}"
+  value       = aws_dynamodb_table.table.id
 }
+
diff --git a/tests/default/main.tf b/tests/default/main.tf
diff --git a/variables.tf b/variables.tf

Original file line number	Diff line number	Diff line change
`@@ -1,14 +1,15 @@`
`1`	`1`	`output "stream_arn" {`
`2`	`2`	description = "ARN for the stream if `stream_enabled` was set to `true`, otherwise returns a string of \"null\"."
`3`		`- value = "${var.stream_enabled == "true" ? aws_dynamodb_table.table.stream_arn : "null" }"`
	`3`	`+ value = var.stream_enabled == "true" ? aws_dynamodb_table.table.stream_arn : "null"`
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`output "table_arn" {`
`7`	`7`	`description = "Table ARN"`
`8`		`- value = "${aws_dynamodb_table.table.arn}"`
	`8`	`+ value = aws_dynamodb_table.table.arn`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`output "table_name" {`
`12`	`12`	`description = "Table Name"`
`13`		`- value = "${aws_dynamodb_table.table.id}"`
	`13`	`+ value = aws_dynamodb_table.table.id`
`14`	`14`	`}`
	`15`	`+`