refactor: change terraform version and add aws provider version

Change variables and outputs descriptions. Add ecs architecture diagram.

Author: saumitra-dev

.header.md

@@ -1,3 +1,7 @@
 # terraform-aws-ecs
 
 A Terraform module to create ECS Cluster that relies on self-managed EC2 instances.
+
+## Architecture Diagram
+
+![ECS Architecture Diagram](./diagrams/ecs-architecture.png)

README.md

@@ -3,11 +3,16 @@
 
 A Terraform module to create ECS Cluster that relies on self-managed EC2 instances.
 
+## Architecture Diagram
+
+![ECS Architecture Diagram](./diagrams/ecs-architecture.png)
+
 ## Requirements
 
 | Name | Version |
 |------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.6.0 |
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >=  1.8.4 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.51.0 |
 
 ## Providers
 
@@ -29,36 +34,36 @@ No resources.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_asg_create_launch_template"></a> [asg\_create\_launch\_template](#input\_asg\_create\_launch\_template) | Either to create a Launch Template to associate with the Autoscaling group | `bool` | `true` | no |
-| <a name="input_asg_desired_capacity"></a> [asg\_desired\_capacity](#input\_asg\_desired\_capacity) | Desired capacity for the Autoscaling group | `number` | n/a | yes |
-| <a name="input_asg_iam_instance_profile_name"></a> [asg\_iam\_instance\_profile\_name](#input\_asg\_iam\_instance\_profile\_name) | Name of the IAM Instance Profile | `string` | `null` | no |
-| <a name="input_asg_iam_instance_profile_tags"></a> [asg\_iam\_instance\_profile\_tags](#input\_asg\_iam\_instance\_profile\_tags) | Resource Tags for the IAM Instance Profile | `map(any)` | `{}` | no |
-| <a name="input_asg_iam_role_name"></a> [asg\_iam\_role\_name](#input\_asg\_iam\_role\_name) | Name for the IAM Role | `string` | `null` | no |
-| <a name="input_asg_iam_role_policy_attachments"></a> [asg\_iam\_role\_policy\_attachments](#input\_asg\_iam\_role\_policy\_attachments) | Policy ARNs to attach to the IAM Role | `list(string)` | <pre>[<br>  "arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceforEC2Role"<br>]</pre> | no |
-| <a name="input_asg_iam_role_tags"></a> [asg\_iam\_role\_tags](#input\_asg\_iam\_role\_tags) | Resource Tags for IAM Role | `map(any)` | `{}` | no |
-| <a name="input_asg_instances_tags"></a> [asg\_instances\_tags](#input\_asg\_instances\_tags) | Resources Tags to propagate to the Instances | `map(any)` | `{}` | no |
-| <a name="input_asg_launch_template"></a> [asg\_launch\_template](#input\_asg\_launch\_template) | Launch Template to use with the Autoscaling group | <pre>object({<br>    name                   = optional(string, null)<br>    image_id               = optional(string, null)<br>    instance_type          = optional(string, null)<br>    vpc_security_group_ids = optional(list(string), [])<br>    key_name               = optional(string, null)<br>    user_data              = optional(string, null)<br>    tags                   = optional(map(any), {})<br>  })</pre> | `{}` | no |
+| <a name="input_asg_desired_capacity"></a> [asg\_desired\_capacity](#input\_asg\_desired\_capacity) | The number of Amazon EC2 instances that should be running in the group. | `number` | n/a | yes |
+| <a name="input_asg_iam_instance_profile_name"></a> [asg\_iam\_instance\_profile\_name](#input\_asg\_iam\_instance\_profile\_name) | (Optional, Forces new resource) Name of the instance profile. | `string` | `null` | no |
+| <a name="input_asg_iam_instance_profile_tags"></a> [asg\_iam\_instance\_profile\_tags](#input\_asg\_iam\_instance\_profile\_tags) | (Optional) Map of resource tags for the IAM Instance Profile. | `map(string)` | `{}` | no |
+| <a name="input_asg_iam_role_name"></a> [asg\_iam\_role\_name](#input\_asg\_iam\_role\_name) | (Optional, Forces new resource) Friendly name of the role. | `string` | `null` | no |
+| <a name="input_asg_iam_role_policy_attachments"></a> [asg\_iam\_role\_policy\_attachments](#input\_asg\_iam\_role\_policy\_attachments) | (Required) - The ARN of the policy you want to apply | `list(string)` | <pre>[<br>  "arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceforEC2Role"<br>]</pre> | no |
+| <a name="input_asg_iam_role_tags"></a> [asg\_iam\_role\_tags](#input\_asg\_iam\_role\_tags) | Key-value mapping of tags for the IAM role. | `map(string)` | `{}` | no |
+| <a name="input_asg_instances_tags"></a> [asg\_instances\_tags](#input\_asg\_instances\_tags) | Resources Tags to propagate to the Instances | `map(string)` | `{}` | no |
+| <a name="input_asg_launch_template"></a> [asg\_launch\_template](#input\_asg\_launch\_template) | Launch Template to use with the Autoscaling group | <pre>object({<br>    name                   = optional(string, null)<br>    image_id               = optional(string, null)<br>    instance_type          = optional(string, null)<br>    vpc_security_group_ids = optional(list(string), [])<br>    key_name               = optional(string, null)<br>    user_data              = optional(string, null)<br>    tags                   = optional(map(string), {})<br>  })</pre> | `{}` | no |
 | <a name="input_asg_launch_template_id"></a> [asg\_launch\_template\_id](#input\_asg\_launch\_template\_id) | Identifier of the Launch Template | `string` | `null` | no |
-| <a name="input_asg_max_size"></a> [asg\_max\_size](#input\_asg\_max\_size) | Max. size for the Autoscaling group | `number` | n/a | yes |
-| <a name="input_asg_min_size"></a> [asg\_min\_size](#input\_asg\_min\_size) | Min. size for the Autoscaling group | `number` | n/a | yes |
-| <a name="input_asg_name"></a> [asg\_name](#input\_asg\_name) | Name of the Autoscaling Group | `string` | n/a | yes |
-| <a name="input_asg_tags"></a> [asg\_tags](#input\_asg\_tags) | Resources Tags for Autoscaling group | `map(any)` | `{}` | no |
-| <a name="input_asg_vpc_zone_identifier"></a> [asg\_vpc\_zone\_identifier](#input\_asg\_vpc\_zone\_identifier) | Identifiers of the VPC Subnets | `list(string)` | n/a | yes |
-| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of the ECS Cluster to create | `string` | n/a | yes |
-| <a name="input_cluster_setting"></a> [cluster\_setting](#input\_cluster\_setting) | Details of the setting configuration | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
-| <a name="input_cluster_tags"></a> [cluster\_tags](#input\_cluster\_tags) | Resource Tags for ECS Cluster | `map(any)` | `{}` | no |
+| <a name="input_asg_max_size"></a> [asg\_max\_size](#input\_asg\_max\_size) | Maximum size of the Auto Scaling Group | `number` | n/a | yes |
+| <a name="input_asg_min_size"></a> [asg\_min\_size](#input\_asg\_min\_size) | Minimum size of the Auto Scaling Group | `number` | n/a | yes |
+| <a name="input_asg_name"></a> [asg\_name](#input\_asg\_name) | (Optional) Name of the Auto Scaling Group. | `string` | n/a | yes |
+| <a name="input_asg_tags"></a> [asg\_tags](#input\_asg\_tags) | Resources Tags for Autoscaling group | `map(string)` | `{}` | no |
+| <a name="input_asg_vpc_zone_identifier"></a> [asg\_vpc\_zone\_identifier](#input\_asg\_vpc\_zone\_identifier) | (Optional) List of subnet IDs to launch resources in. | `list(string)` | n/a | yes |
+| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | (Required) Name of the cluster | `string` | n/a | yes |
+| <a name="input_cluster_setting"></a> [cluster\_setting](#input\_cluster\_setting) | (Optional) Configuration block(s) with cluster settings. | <pre>list(object({<br>    name  = string<br>    value = string<br>  }))</pre> | `[]` | no |
+| <a name="input_cluster_tags"></a> [cluster\_tags](#input\_cluster\_tags) | (Optional) Key-value map of resource tags. | `map(string)` | `{}` | no |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| <a name="output_asg_arn"></a> [asg\_arn](#output\_asg\_arn) | ARN of the Autoscaling group |
-| <a name="output_asg_iam_instance_profile_arn"></a> [asg\_iam\_instance\_profile\_arn](#output\_asg\_iam\_instance\_profile\_arn) | ARN of the IAM Instance Profile being used with the Launch Template |
-| <a name="output_asg_iam_instance_profile_id"></a> [asg\_iam\_instance\_profile\_id](#output\_asg\_iam\_instance\_profile\_id) | Identifier of the IAM Instance Profile being used with the Launch Template |
-| <a name="output_asg_iam_role_id"></a> [asg\_iam\_role\_id](#output\_asg\_iam\_role\_id) | Identifier of the IAM Role being used with the IAM Instnace Profile |
-| <a name="output_asg_id"></a> [asg\_id](#output\_asg\_id) | Identifier of the Autoscaling group |
-| <a name="output_asg_launch_template_arn"></a> [asg\_launch\_template\_arn](#output\_asg\_launch\_template\_arn) | ARN of the Launch Template being used with the Autoscaling Group |
-| <a name="output_asg_launch_template_id"></a> [asg\_launch\_template\_id](#output\_asg\_launch\_template\_id) | Identifier of the Launch Template being used with the Autoscaling Group |
-| <a name="output_cluster_arn"></a> [cluster\_arn](#output\_cluster\_arn) | ARN of the ECS Cluster |
+| <a name="output_asg_arn"></a> [asg\_arn](#output\_asg\_arn) | ARN for this Auto Scaling Group. |
+| <a name="output_asg_iam_instance_profile_arn"></a> [asg\_iam\_instance\_profile\_arn](#output\_asg\_iam\_instance\_profile\_arn) | ARN assigned by AWS to the instance profile. |
+| <a name="output_asg_iam_instance_profile_id"></a> [asg\_iam\_instance\_profile\_id](#output\_asg\_iam\_instance\_profile\_id) | Instance profile's ID. |
+| <a name="output_asg_iam_role_id"></a> [asg\_iam\_role\_id](#output\_asg\_iam\_role\_id) | Name of the role. |
+| <a name="output_asg_id"></a> [asg\_id](#output\_asg\_id) | Auto Scaling Group id. |
+| <a name="output_asg_launch_template_arn"></a> [asg\_launch\_template\_arn](#output\_asg\_launch\_template\_arn) | Amazon Resource Name (ARN) of the launch template. |
+| <a name="output_asg_launch_template_id"></a> [asg\_launch\_template\_id](#output\_asg\_launch\_template\_id) | The ID of the launch template. |
+| <a name="output_cluster_arn"></a> [cluster\_arn](#output\_cluster\_arn) | ARN that identifies the cluster. |
 | <a name="output_cluster_id"></a> [cluster\_id](#output\_cluster\_id) | Identifier of the ECS Cluster |
 | <a name="output_cluster_name"></a> [cluster\_name](#output\_cluster\_name) | Name of the ECS Cluster |
 <!-- END_TF_DOCS -->

diagrams/ecs-architecture.png

@@ -8,7 +8,7 @@ output "cluster_id" {
 }
 
 output "cluster_arn" {
-  description = "ARN of the ECS Cluster"
+  description = "ARN that identifies the cluster."
   value       = module.cluster.arn
 }
 
@@ -22,12 +22,12 @@ output "cluster_name" {
 ################################################################################
 
 output "asg_id" {
-  description = "Identifier of the Autoscaling group"
+  description = "Auto Scaling Group id."
   value       = module.asg.id
 }
 
 output "asg_arn" {
-  description = "ARN of the Autoscaling group"
+  description = "ARN for this Auto Scaling Group."
   value       = module.asg.arn
 }
 
@@ -36,12 +36,12 @@ output "asg_arn" {
 ################################################################################
 
 output "asg_launch_template_id" {
-  description = "Identifier of the Launch Template being used with the Autoscaling Group"
+  description = "The ID of the launch template."
   value       = module.asg.launch_template_id
 }
 
 output "asg_launch_template_arn" {
-  description = "ARN of the Launch Template being used with the Autoscaling Group"
+  description = "Amazon Resource Name (ARN) of the launch template."
   value       = module.asg.launch_template_arn
 }
 
@@ -50,16 +50,16 @@ output "asg_launch_template_arn" {
 ################################################################################
 
 output "asg_iam_role_id" {
-  description = "Identifier of the IAM Role being used with the IAM Instnace Profile"
+  description = "Name of the role."
   value       = module.asg.iam_role_id
 }
 
 output "asg_iam_instance_profile_id" {
-  description = "Identifier of the IAM Instance Profile being used with the Launch Template"
+  description = "Instance profile's ID."
   value       = module.asg.iam_instance_profile_id
 }
 
 output "asg_iam_instance_profile_arn" {
-  description = "ARN of the IAM Instance Profile being used with the Launch Template"
+  description = "ARN assigned by AWS to the instance profile."
   value       = module.asg.iam_instance_profile_arn
 }

outputs.tf

@@ -1,14 +1,10 @@
-################################################################################
-# ECS Cluster
-################################################################################
-
 variable "cluster_name" {
-  description = "Name of the ECS Cluster to create"
+  description = "(Required) Name of the cluster"
   type        = string
 }
 
 variable "cluster_setting" {
-  description = "Details of the setting configuration"
+  description = "(Optional) Configuration block(s) with cluster settings."
   type = list(object({
     name  = string
     value = string
@@ -17,8 +13,8 @@ variable "cluster_setting" {
 }
 
 variable "cluster_tags" {
-  description = "Resource Tags for ECS Cluster"
-  type        = map(any)
+  description = "(Optional) Key-value map of resource tags."
+  type        = map(string)
   default     = {}
 }
 
@@ -27,12 +23,12 @@ variable "cluster_tags" {
 ################################################################################
 
 variable "asg_name" {
-  description = "Name of the Autoscaling Group"
+  description = "(Optional) Name of the Auto Scaling Group."
   type        = string
 }
 
 variable "asg_vpc_zone_identifier" {
-  description = "Identifiers of the VPC Subnets"
+  description = "(Optional) List of subnet IDs to launch resources in."
   type        = list(string)
 
   validation {
@@ -42,7 +38,7 @@ variable "asg_vpc_zone_identifier" {
 }
 
 variable "asg_desired_capacity" {
-  description = "Desired capacity for the Autoscaling group"
+  description = "The number of Amazon EC2 instances that should be running in the group."
   type        = number
 
   validation {
@@ -52,7 +48,7 @@ variable "asg_desired_capacity" {
 }
 
 variable "asg_min_size" {
-  description = "Min. size for the Autoscaling group"
+  description = "Minimum size of the Auto Scaling Group"
   type        = number
 
   validation {
@@ -62,7 +58,7 @@ variable "asg_min_size" {
 }
 
 variable "asg_max_size" {
-  description = "Max. size for the Autoscaling group"
+  description = "Maximum size of the Auto Scaling Group"
   type        = number
 
   validation {
@@ -73,13 +69,13 @@ variable "asg_max_size" {
 
 variable "asg_instances_tags" {
   description = "Resources Tags to propagate to the Instances"
-  type        = map(any)
+  type        = map(string)
   default     = {}
 }
 
 variable "asg_tags" {
   description = "Resources Tags for Autoscaling group"
-  type        = map(any)
+  type        = map(string)
   default     = {}
 }
 
@@ -96,7 +92,7 @@ variable "asg_launch_template" {
     vpc_security_group_ids = optional(list(string), [])
     key_name               = optional(string, null)
     user_data              = optional(string, null)
-    tags                   = optional(map(any), {})
+    tags                   = optional(map(string), {})
   })
   default = {}
 }
@@ -123,22 +119,22 @@ variable "asg_launch_template_id" {
 ################################################################################
 
 variable "asg_iam_role_name" {
-  description = "Name for the IAM Role"
+  description = "(Optional, Forces new resource) Friendly name of the role."
   type        = string
   default     = null
 }
 
 variable "asg_iam_role_policy_attachments" {
-  description = "Policy ARNs to attach to the IAM Role"
+  description = "(Required) - The ARN of the policy you want to apply"
   type        = list(string)
   default = [
     "arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceforEC2Role"
   ]
 }
 
 variable "asg_iam_role_tags" {
-  description = "Resource Tags for IAM Role"
-  type        = map(any)
+  description = "Key-value mapping of tags for the IAM role."
+  type        = map(string)
   default     = {}
 }
 
@@ -147,13 +143,13 @@ variable "asg_iam_role_tags" {
 ################################################################################
 
 variable "asg_iam_instance_profile_name" {
-  description = "Name of the IAM Instance Profile"
+  description = "(Optional, Forces new resource) Name of the instance profile."
   type        = string
   default     = null
 }
 
 variable "asg_iam_instance_profile_tags" {
-  description = "Resource Tags for the IAM Instance Profile"
-  type        = map(any)
+  description = "(Optional) Map of resource tags for the IAM Instance Profile."
+  type        = map(string)
   default     = {}
 }

variables.tf

@@ -1,3 +1,10 @@
 terraform {
-  required_version = ">= 1.6.0"
+  required_version = ">=  1.8.4"
+
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 5.51.0"
+    }
+  }
 }