Merge pull request #15 from thaunghtike-share/main

create descriptions for variables.tf

Author: abhiyerra

README.md

@@ -41,27 +41,26 @@ terraform destroy -auto-approve
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | n/a |
-| <a name="provider_cloudinit"></a> [cloudinit](#provider\_cloudinit) | n/a |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | 4.15.1 |
+| <a name="provider_cloudinit"></a> [cloudinit](#provider\_cloudinit) | 2.2.0 |
 ## Inputs
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| <a name="input_ami_id"></a> [ami\_id](#input\_ami\_id) | n/a | `any` | `null` | no |
-| <a name="input_bastion_name"></a> [bastion\_name](#input\_bastion\_name) | n/a | `any` | n/a | yes |
-| <a name="input_ec2_connect_enabled"></a> [ec2\_connect\_enabled](#input\_ec2\_connect\_enabled) | n/a | `bool` | `true` | no |
-| <a name="input_ingress_cidrs"></a> [ingress\_cidrs](#input\_ingress\_cidrs) | n/a | `any` | n/a | yes |
-| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | n/a | `string` | `"t3.micro"` | no |
-| <a name="input_security_group_ids"></a> [security\_group\_ids](#input\_security\_group\_ids) | n/a | `list` | `[]` | no |
-| <a name="input_ssh_keys"></a> [ssh\_keys](#input\_ssh\_keys) | SSH public keys to add to the image | `list` | `[]` | no |
-| <a name="input_subnet_id"></a> [subnet\_id](#input\_subnet\_id) | n/a | `any` | n/a | yes |
-| <a name="input_tags"></a> [tags](#input\_tags) | n/a | `map` | `{}` | no |
-| <a name="input_ubuntu_version"></a> [ubuntu\_version](#input\_ubuntu\_version) | n/a | `string` | `"20.04"` | no |
-| <a name="input_user_data"></a> [user\_data](#input\_user\_data) | n/a | `string` | `""` | no |
-| <a name="input_user_data_replace_on_change"></a> [user\_data\_replace\_on\_change](#input\_user\_data\_replace\_on\_change) | n/a | `bool` | `false` | no |
-| <a name="input_userdata"></a> [userdata](#input\_userdata) | n/a | `string` | `""` | no |
-| <a name="input_volume_size"></a> [volume\_size](#input\_volume\_size) | n/a | `number` | `20` | no |
-| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | n/a | `any` | n/a | yes |
+| <a name="input_ami_id"></a> [ami\_id](#input\_ami\_id) | The AMI ID of the bastion host | `string` | `null` | no |
+| <a name="input_bastion_name"></a> [bastion\_name](#input\_bastion\_name) | The name of the bastion host | `string` | n/a | yes |
+| <a name="input_ingress_cidrs"></a> [ingress\_cidrs](#input\_ingress\_cidrs) | Configuration block for ingress rules | `any` | n/a | yes |
+| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | EC2 Instance Type of the bastion host | `string` | `"t3.micro"` | no |
+| <a name="input_security_group_ids"></a> [security\_group\_ids](#input\_security\_group\_ids) | A list of security group names to associate with. | `list(any)` | `[]` | no |
+| <a name="input_ssh_keys"></a> [ssh\_keys](#input\_ssh\_keys) | SSH public keys to add to the image | `list(any)` | `[]` | no |
+| <a name="input_subnet_id"></a> [subnet\_id](#input\_subnet\_id) | The VPC subnet ID to launch in EC2 bastion host | `string` | n/a | yes |
+| <a name="input_tags"></a> [tags](#input\_tags) | A map of tags to assign to the resource | `map(any)` | `{}` | no |
+| <a name="input_ubuntu_version"></a> [ubuntu\_version](#input\_ubuntu\_version) | Ubuntu Server Version | `string` | `"20.04"` | no |
+| <a name="input_user_data"></a> [user\_data](#input\_user\_data) | User data to provide when launching the instance | `string` | `""` | no |
+| <a name="input_user_data_replace_on_change"></a> [user\_data\_replace\_on\_change](#input\_user\_data\_replace\_on\_change) | To recreate the instance when user\_data is changed | `bool` | `false` | no |
+| <a name="input_userdata"></a> [userdata](#input\_userdata) | User data to provide when launching the instance | `string` | `""` | no |
+| <a name="input_volume_size"></a> [volume\_size](#input\_volume\_size) | Size of the volume in gibibytes (GiB) | `number` | `20` | no |
+| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The VPC ID to create security group for bastion host | `string` | n/a | yes |
 ## Resources
 
 | Name | Type |
@@ -78,4 +77,4 @@ terraform destroy -auto-approve
 | Name | Description |
 |------|-------------|
 | <a name="output_public_ip"></a> [public\_ip](#output\_public\_ip) | n/a |
-<!-- END_TF_DOCS -->
+<!-- END_TF_DOCS -->

main.tf

@@ -44,7 +44,7 @@ resource "aws_instance" "this" {
 
   monitoring = true
 
-  tags                        = merge(var.tags, {
+  tags = merge(var.tags, {
     Name = var.bastion_name
   })
   user_data_replace_on_change = var.user_data_replace_on_change

variables.tf

@@ -1,47 +1,79 @@
 variable "ami_id" {
-  default = null
+  default     = null
+  type        = string
+  description = "The AMI ID of the bastion host"
+}
+
+variable "bastion_name" {
+  description = "The name of the bastion host"
+  type        = string
 }
 
-variable "bastion_name" {}
 variable "ssh_keys" {
   description = "SSH public keys to add to the image"
   default     = []
+  type        = list(any)
 }
+
 variable "tags" {
-  default = {}
+  default     = {}
+  description = "A map of tags to assign to the resource"
+  type        = map(any)
+}
+
+variable "vpc_id" {
+  description = "The VPC ID to create security group for bastion host"
+  type        = string
+}
+
+variable "subnet_id" {
+  description = "The VPC subnet ID to launch in EC2 bastion host"
+  type        = string
 }
 
-variable "vpc_id" {}
-variable "subnet_id" {}
 variable "security_group_ids" {
-  default = []
+  default     = []
+  description = "A list of security group names to associate with."
+  type        = list(any)
 }
+
 variable "ubuntu_version" {
-  default = "20.04"
+  default     = "20.04"
+  description = "Ubuntu Server Version"
+  type        = string
 }
 
 variable "userdata" {
-  default = ""
+  default     = ""
+  description = "User data to provide when launching the instance"
+  type        = string
 }
 
 variable "volume_size" {
-  default = 20
+  default     = 20
+  description = "Size of the volume in gibibytes (GiB)"
+  type        = number
+
 }
 
 variable "instance_type" {
-  default = "t3.micro"
+  default     = "t3.micro"
+  description = "EC2 Instance Type of the bastion host"
+  type        = string
 }
 
-variable "ingress_cidrs" {}
-
-variable "ec2_connect_enabled" {
-  default = true
+variable "ingress_cidrs" {
+  description = "Configuration block for ingress rules"
 }
 
 variable "user_data" {
-  default = ""
+  default     = ""
+  description = "User data to provide when launching the instance"
+  type        = string
 }
 
 variable "user_data_replace_on_change" {
-  default = false
+  default     = false
+  description = "To recreate the instance when user_data is changed"
+  type        = bool
 }