Merge pull request #17 from rackspace-infrastructure-automation/gdv/custom_header_type

Update custom header type

Author: gdelvalle

README.md

@@ -1,16 +1,16 @@
 # aws-terraform-cloudfront\_s3\_origin
 
-This modules creates an AWS CloudFront distribution with S3 origin  
-Enable Logging  
+This modules creates an AWS CloudFront distribution with S3 origin
+### Enable Logging  
 If you enable logging the bucket must already exist. You will get an error if you try  
-to use a dynamic bucket like "${aws\_s3\_bucket.cloudfront\_log\_s3bucket.bucket\_domain\_name}"  
-You must use something like bucket = "MyExistingbucket"
+to use a dynamic bucket like `"${aws_s3_bucket.cloudfront_log_s3bucket.bucket_domain_name}"`.  
+You must use something like `bucket = "MyExistingbucket"`.
 
 ## Basic Usage
 
 ```
 module "cloudfront_s3_origin" {
-  source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-cloudfront_s3_origin//?ref=v0.12.0"
+  source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-cloudfront_s3_origin//?ref=v0.12.1"
 
   allowed_methods                 = ["GET", "HEAD"]
   bucket_logging                  = false
@@ -46,16 +46,22 @@ module "cloudfront_s3_origin" {
     },
   ]
 }
-*
 ```
 
 Full working references are available at [examples](examples)
 
+## Terraform 0.12 upgrade
+
+Several changes were made while adding terraform 0.12 compatibility.  
+The main change to be aware of is the `customer_header` variable  
+changed types from `list(string)` to `list(map(string))` to properly function with dynamic  
+configuration blocks.
+
 ## Providers
 
 | Name | Version |
 |------|---------|
-| aws | >= 2.1.0 |
+| aws | >= 2.7.0 |
 
 ## Inputs
 
@@ -71,7 +77,7 @@ Full working references are available at [examples](examples)
 | comment | Any comments you want to include about the distribution. (OPTIONAL) | `string` | `""` | no |
 | compress | Indicates whether CloudFront automatically compresses certain files for this cache behavior. (OPTIONAL) | `bool` | `false` | no |
 | custom\_error\_response | (Optional) - List of one or more custom error response element maps | `list(map(string))` | `[]` | no |
-| custom\_header | One or more sub-resources with name and value parameters that specify header data that will be sent to the origin | `list(string)` | `[]` | no |
+| custom\_header | One or more sub-resources with name and value parameters that specify header data that will be sent to the origin. For example: `[{name = "header1", value = "value1"}]`. | `list(map(string))` | `[]` | no |
 | default\_root\_object | The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL. | `string` | `""` | no |
 | default\_ttl | The default time in seconds that objects stay in CloudFront caches before CloudFront forwards another request to your custom origin to determine whether the object has been updated. | `number` | `3600` | no |
 | domain\_name | The DNS domain name of either the S3 bucket, or web site of your custom origin. | `string` | `""` | no |

examples/cloudfront_s3_origin.tf

@@ -3,7 +3,8 @@ terraform {
 }
 
 provider "aws" {
-  region = "us-west-2"
+  version = "~> 2.7"
+  region  = "us-west-2"
 }
 
 resource "random_string" "cloudfront_rstring" {
@@ -49,7 +50,7 @@ resource "aws_s3_bucket_policy" "cloudfront_s3bucket_policy" {
 }
 
 module "cloudfront_s3_origin" {
-  source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-cloudfront_s3_origin//?ref=v0.12.0"
+  source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-cloudfront_s3_origin//?ref=v0.12.1"
 
   allowed_methods                 = ["GET", "HEAD"]
   bucket_logging                  = false

main.tf

@@ -2,16 +2,16 @@
  * # aws-terraform-cloudfront_s3_origin
  *
  * This modules creates an AWS CloudFront distribution with S3 origin
- * Enable Logging
+ * ### Enable Logging
  * If you enable logging the bucket must already exist. You will get an error if you try
- * to use a dynamic bucket like "${aws_s3_bucket.cloudfront_log_s3bucket.bucket_domain_name}"
- * You must use something like bucket = "MyExistingbucket"
+ * to use a dynamic bucket like `"${aws_s3_bucket.cloudfront_log_s3bucket.bucket_domain_name}"`.
+ * You must use something like `bucket = "MyExistingbucket"`.
  *
  * ## Basic Usage
  *
  * ```
  * module "cloudfront_s3_origin" {
- *   source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-cloudfront_s3_origin//?ref=v0.12.0"
+ *   source = "git@github.com:rackspace-infrastructure-automation/aws-terraform-cloudfront_s3_origin//?ref=v0.12.1"
  *
  *   allowed_methods                 = ["GET", "HEAD"]
  *   bucket_logging                  = false
@@ -47,21 +47,27 @@
  *     },
  *   ]
  * }
- *```
+ * ```
  *
  * Full working references are available at [examples](examples)
+ *
+ * ## Terraform 0.12 upgrade
+ *
+ * Several changes were made while adding terraform 0.12 compatibility.
+ * The main change to be aware of is the `customer_header` variable
+ * changed types from `list(string)` to `list(map(string))` to properly function with dynamic
+ * configuration blocks.
  */
 
 terraform {
   required_version = ">= 0.12"
 
   required_providers {
-    aws = ">= 2.1.0"
+    aws = ">= 2.7.0"
   }
 }
 
 locals {
-  bucket_logging_config = var.bucket_logging ? "enabled" : "disabled"
 
   tags = {
     Name            = var.origin_id
@@ -70,14 +76,9 @@ locals {
   }
 
   bucket_logging = {
-    enabled = [
-      {
-        bucket          = var.bucket
-        include_cookies = var.include_cookies
-        prefix          = var.prefix
-      },
-    ]
-    disabled = []
+    bucket          = var.bucket
+    include_cookies = var.include_cookies
+    prefix          = var.prefix
   }
 
   active_trusted_signers = coalescelist(
@@ -130,7 +131,7 @@ resource "aws_cloudfront_distribution" "cf_distribution" {
   }
 
   dynamic "logging_config" {
-    for_each = local.bucket_logging[local.bucket_logging_config]
+    for_each = var.bucket_logging ? [local.bucket_logging] : []
     content {
       bucket          = logging_config.value.bucket
       include_cookies = lookup(logging_config.value, "include_cookies", null)
@@ -225,7 +226,7 @@ resource "aws_cloudfront_distribution" "cf_distribution_no_s3_origin_config" {
   }
 
   dynamic "logging_config" {
-    for_each = local.bucket_logging[local.bucket_logging_config]
+    for_each = var.bucket_logging ? [local.bucket_logging] : []
     content {
       bucket          = logging_config.value.bucket
       include_cookies = lookup(logging_config.value, "include_cookies", null)

tests/test1/main.tf

@@ -3,7 +3,7 @@ terraform {
 }
 
 provider "aws" {
-  version = "~> 2.2"
+  version = "~> 2.7"
   region  = "us-west-2"
 }
 
@@ -54,6 +54,7 @@ module "cloudfront_s3_origin" {
 
   allowed_methods                 = ["GET", "HEAD"]
   bucket_logging                  = false
+  custom_header                   = [{ name = "header1", value = "value1" }, { name = "header2", value = "value2" }]
   cached_methods                  = ["GET", "HEAD"]
   cloudfront_default_certificate  = true
   comment                         = "This is a test comment"

variables.tf

@@ -69,8 +69,8 @@ variable "custom_error_response" {
 }
 
 variable "custom_header" {
-  description = "One or more sub-resources with name and value parameters that specify header data that will be sent to the origin"
-  type        = list(string)
+  description = "One or more sub-resources with name and value parameters that specify header data that will be sent to the origin. For example: `[{name = \"header1\", value = \"value1\"}]`."
+  type        = list(map(string))
   default     = []
 }