Add support for network address usage metrics (#124)

Co-authored-by: Johan Lanzrein <jlanzrein@pictet.com>

Author: lanzrein

README.md

@@ -248,6 +248,7 @@ Available targets:
 | <a name="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 |
 | <a name="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 |
 | <a name="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 |
+| <a name="input_network_address_usage_metrics_enabled"></a> [network\_address\_usage\_metrics\_enabled](#input\_network\_address\_usage\_metrics\_enabled) | Set `true` to enable Network Address Usage Metrics for the VPC | `bool` | `false` | no |
 | <a name="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 |
 | <a name="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 |
 | <a name="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 |

docs/terraform.md

@@ -67,6 +67,7 @@
 | <a name="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 |
 | <a name="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 |
 | <a name="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 |
+| <a name="input_network_address_usage_metrics_enabled"></a> [network\_address\_usage\_metrics\_enabled](#input\_network\_address\_usage\_metrics\_enabled) | Set `true` to enable Network Address Usage Metrics for the VPC | `bool` | `false` | no |
 | <a name="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 |
 | <a name="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 |
 | <a name="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 |

examples/complete/fixtures.us-east-2.tfvars

@@ -8,6 +8,7 @@ stage = "test"
 
 name = "vpc-subnets"
 
-default_security_group_deny_all = true
-default_route_table_no_routes   = true
-default_network_acl_deny_all    = true
+default_security_group_deny_all       = true
+default_route_table_no_routes         = true
+default_network_acl_deny_all          = true
+network_address_usage_metrics_enabled = true 

examples/complete/main.tf

@@ -20,11 +20,11 @@ module "vpc" {
 
   assign_generated_ipv6_cidr_block = true
 
-  default_security_group_deny_all = var.default_security_group_deny_all
-  default_route_table_no_routes   = var.default_route_table_no_routes
-  default_network_acl_deny_all    = var.default_network_acl_deny_all
-
-  context = module.this.context
+  default_security_group_deny_all       = var.default_security_group_deny_all
+  default_route_table_no_routes         = var.default_route_table_no_routes
+  default_network_acl_deny_all          = var.default_network_acl_deny_all
+  network_address_usage_metrics_enabled = var.network_address_usage_metrics_enabled
+  context                               = module.this.context
 }
 
 module "subnets" {

examples/complete/variables.tf

@@ -17,3 +17,7 @@ variable "default_route_table_no_routes" {
 variable "default_network_acl_deny_all" {
   type = bool
 }
+
+variable "network_address_usage_metrics_enabled" {
+  type = bool
+}

main.tf

@@ -41,11 +41,12 @@ resource "aws_vpc" "default" {
   ipv6_netmask_length = try(var.ipv6_primary_cidr_block_association.ipv6_netmask_length, null)
   # Additional IPv6 CIDRs are handled by aws_vpc_ipv6_cidr_block_association below
 
-  instance_tenancy                 = var.instance_tenancy
-  enable_dns_hostnames             = local.dns_hostnames_enabled
-  enable_dns_support               = local.dns_support_enabled
-  assign_generated_ipv6_cidr_block = local.assign_generated_ipv6_cidr_block
-  tags                             = module.label.tags
+  instance_tenancy                     = var.instance_tenancy
+  enable_dns_hostnames                 = local.dns_hostnames_enabled
+  enable_dns_support                   = local.dns_support_enabled
+  assign_generated_ipv6_cidr_block     = local.assign_generated_ipv6_cidr_block
+  enable_network_address_usage_metrics = var.network_address_usage_metrics_enabled
+  tags                                 = module.label.tags
 }
 
 # If `aws_default_security_group` is not defined, it will be created implicitly with access `0.0.0.0/0`

variables.tf

@@ -155,3 +155,9 @@ variable "ipv6_egress_only_internet_gateway_enabled" {
   description = "Set `true` to create an IPv6 Egress-Only Internet Gateway for the VPC"
   default     = false
 }
+
+variable "network_address_usage_metrics_enabled" {
+  type        = bool
+  description = "Set `true` to enable Network Address Usage Metrics for the VPC"
+  default     = false
+}