Skip to content

Commit

Permalink
terraform-docs: automated action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Mar 25, 2024
1 parent 5af6217 commit af44489
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ module "ad2" {

| Name | Source | Version |
|------|--------|---------|
| <a name="module_security_group"></a> [security\_group](#module\_security\_group) | github.com/Coalfire-CF/terraform-aws-securitygroup | b7720e6f7bf50f8ecd39d90818523efcc5e896aa |
| <a name="module_security_group"></a> [security\_group](#module\_security\_group) | github.com/Coalfire-CF/terraform-aws-securitygroup | b6e9070a3f6201d75160c42a3f649d36cb9b2622 |

## Resources

Expand Down Expand Up @@ -208,13 +208,13 @@ module "ad2" {
| <a name="input_ebs_volumes"></a> [ebs\_volumes](#input\_ebs\_volumes) | A list of maps that must contain device\_name (ex. '/dev/sdb') and size (in GB). Optional args include type, throughput, iops, multi\_attach\_enabled, final\_snapshot, snapshot\_id, outpost\_arn, force\_detach, skip\_destroy, stop\_instance\_before\_detaching, and tags | <pre>list(object({<br> device_name = string<br> size = number<br> type = string<br> throughput = optional(number)<br> iops = optional(number)<br> multi_attach_enabled = optional(bool, false)<br> final_snapshot = optional(string)<br> snapshot_id = optional(string)<br> outpost_arn = optional(string)<br> force_detach = optional(bool, false)<br> skip_destroy = optional(bool, false)<br> stop_instance_before_detaching = optional(bool, false)<br> tags = optional(map(string), {})<br> }))</pre> | `[]` | no |
| <a name="input_ec2_instance_type"></a> [ec2\_instance\_type](#input\_ec2\_instance\_type) | The type of instance to start | `string` | n/a | yes |
| <a name="input_ec2_key_pair"></a> [ec2\_key\_pair](#input\_ec2\_key\_pair) | The key name to use for the instance | `string` | n/a | yes |
| <a name="input_egress_rules"></a> [egress\_rules](#input\_egress\_rules) | The list of rules for egress traffic. Required fields for each rule are 'protocol', 'from\_port', 'to\_port', and at least one of 'cidr\_blocks', 'ipv6\_cidr\_blocks', 'security\_groups', 'self', or 'prefix\_list\_sg'. Optional fields are 'description' and those not used from the previous list | <pre>map(object({<br> cidr_ipv4 = optional(string, null)<br> cidr_ipv4 = optional(string, null)<br> description = optional(string, "Managed by Terraform")<br> from_port = optional(string, null)<br> ip_protocol = optional(string, null)<br> prefix_list_id = optional(string, null)<br> referenced_security_group_id = optional(string, null)<br> to_port = optional(string, null)<br> }))</pre> | `{}` | no |
| <a name="input_egress_rules"></a> [egress\_rules](#input\_egress\_rules) | The list of rules for egress traffic. Required fields for each rule are 'protocol', 'from\_port', 'to\_port', and at least one of 'cidr\_blocks', 'ipv6\_cidr\_blocks', 'security\_groups', 'self', or 'prefix\_list\_sg'. Optional fields are 'description' and those not used from the previous list | <pre>map(object({<br> cidr_ipv4 = optional(string, null)<br> cidr_ipv6 = optional(string, null)<br> description = optional(string, "Managed by Terraform")<br> from_port = optional(string, null)<br> ip_protocol = optional(string, null)<br> prefix_list_id = optional(string, null)<br> referenced_security_group_id = optional(string, null)<br> to_port = optional(string, null)<br> }))</pre> | `{}` | no |
| <a name="input_get_password_data"></a> [get\_password\_data](#input\_get\_password\_data) | Whether or not to allow retrieval of the local admin password | `bool` | `false` | no |
| <a name="input_global_tags"></a> [global\_tags](#input\_global\_tags) | a map of strings that contains global level tags | `map(string)` | n/a | yes |
| <a name="input_http_tokens"></a> [http\_tokens](#input\_http\_tokens) | Whether or not the metadata service requires session tokens, required=IMDSv2, optional=IMDSv1 | `any` | `"required"` | no |
| <a name="input_iam_policies"></a> [iam\_policies](#input\_iam\_policies) | A list of the iam policy ARNs to attach to the IAM role | `list(string)` | `[]` | no |
| <a name="input_iam_profile"></a> [iam\_profile](#input\_iam\_profile) | A variable to attach an existing iam profile to the ec2 instance(s) created | `string` | `""` | no |
| <a name="input_ingress_rules"></a> [ingress\_rules](#input\_ingress\_rules) | The list of rules for ingress traffic. Required fields for each rule are 'protocol', 'from\_port', 'to\_port', and at least one of 'cidr\_blocks', 'ipv6\_cidr\_blocks', 'security\_groups', 'self', or 'prefix\_list\_sg'. Optional fields are 'description' and those not used from the previous list | <pre>map(object({<br> cidr_ipv4 = optional(string, null)<br> cidr_ipv4 = optional(string, null)<br> description = optional(string, "Managed by Terraform")<br> from_port = optional(string, null)<br> ip_protocol = optional(string, null)<br> prefix_list_id = optional(string, null)<br> referenced_security_group_id = optional(string, null)<br> to_port = optional(string, null)<br> }))</pre> | `{}` | no |
| <a name="input_ingress_rules"></a> [ingress\_rules](#input\_ingress\_rules) | The list of rules for ingress traffic. Required fields for each rule are 'protocol', 'from\_port', 'to\_port', and at least one of 'cidr\_blocks', 'ipv6\_cidr\_blocks', 'security\_groups', 'self', or 'prefix\_list\_sg'. Optional fields are 'description' and those not used from the previous list | <pre>map(object({<br> cidr_ipv4 = optional(string, null)<br> cidr_ipv6 = optional(string, null)<br> description = optional(string, "Managed by Terraform")<br> from_port = optional(string, null)<br> ip_protocol = optional(string, null)<br> prefix_list_id = optional(string, null)<br> referenced_security_group_id = optional(string, null)<br> to_port = optional(string, null)<br> }))</pre> | `{}` | no |
| <a name="input_instance_count"></a> [instance\_count](#input\_instance\_count) | Number of instances to launch | `number` | `1` | no |
| <a name="input_keys_to_grant"></a> [keys\_to\_grant](#input\_keys\_to\_grant) | A list of kms keys to grant permissions to for the role created. | `list(string)` | `[]` | no |
| <a name="input_name"></a> [name](#input\_name) | The name of the ec2 instance | `string` | n/a | yes |
Expand Down

0 comments on commit af44489

Please sign in to comment.