Skip to content

Commit 701dfa4

Browse files
terraform-docs: automated action
1 parent e3c54eb commit 701dfa4

File tree

3 files changed

+4
-9
lines changed

3 files changed

+4
-9
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,16 @@ Terraform module to deploy production-ready applications and services on an exis
4040
| Name | Description | Type | Default | Required |
4141
|------|-------------|------|---------|:--------:|
4242
| <a name="input_acm_amazon_issued_certificates"></a> [acm\_amazon\_issued\_certificates](#input\_acm\_amazon\_issued\_certificates) | Amazon-issued ACM certificates to create. | `any` | `{}` | no |
43-
| <a name="input_acm_imported_certificates"></a> [acm\_imported\_certificates](#input\_acm\_imported\_certificates) | Imported ACM certificates to create. | `any` | `{}` | no |
4443
| <a name="input_capacity_provider_default_auto_scaling_group_arn"></a> [capacity\_provider\_default\_auto\_scaling\_group\_arn](#input\_capacity\_provider\_default\_auto\_scaling\_group\_arn) | ARN for this Auto Scaling Group. | `string` | `null` | no |
4544
| <a name="input_capacity_providers"></a> [capacity\_providers](#input\_capacity\_providers) | Capacity Providers to associate with the ECS Cluster. | `any` | `{}` | no |
4645
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | (Required) Name of the cluster. | `string` | n/a | yes |
4746
| <a name="input_create_acm"></a> [create\_acm](#input\_create\_acm) | Creates the ACM certificates to use with the Load Balancer. | `bool` | `false` | no |
4847
| <a name="input_create_alb"></a> [create\_alb](#input\_create\_alb) | Creates a new Application Load Balancer to use with the ECS Service. | `bool` | `true` | no |
4948
| <a name="input_create_capacity_provider"></a> [create\_capacity\_provider](#input\_create\_capacity\_provider) | Creates a new Capacity Provider to use with the Autoscaling Group. | `bool` | `true` | no |
5049
| <a name="input_default_capacity_providers_strategies"></a> [default\_capacity\_providers\_strategies](#input\_default\_capacity\_providers\_strategies) | (Optional) Set of capacity provider strategies to use by default for the cluster. | `any` | `[]` | no |
51-
| <a name="input_load_balancer"></a> [load\_balancer](#input\_load\_balancer) | Configuration for the Application Load Balancer. | `any` | `{}` | no |
52-
| <a name="input_service"></a> [service](#input\_service) | Configuration for ECS Service. | `any` | n/a | yes |
53-
| <a name="input_task_definition"></a> [task\_definition](#input\_task\_definition) | ECS Task Definition to use for running tasks. | `any` | n/a | yes |
50+
| <a name="input_load_balancer"></a> [load\_balancer](#input\_load\_balancer) | Configuration for the Application Load Balancer. | <pre>object({<br> name = optional(string)<br> internal = optional(bool, false)<br> subnets_ids = optional(list(string), [])<br> security_groups_ids = optional(list(string), [])<br> preserve_host_header = optional(bool)<br> enable_deletion_protection = optional(bool, false)<br> target_groups = optional(any, {})<br> listeners = optional(any, {})<br> listener_rules = optional(any, {})<br> tags = optional(map(string), {})<br> })</pre> | `{}` | no |
51+
| <a name="input_service"></a> [service](#input\_service) | Configuration for ECS Service. | <pre>object({<br> name = string<br> deployment_maximum_percent = optional(number)<br> deployment_minimum_healthy_percent = optional(number)<br> desired_count = optional(number)<br> enable_ecs_managed_tags = optional(bool, true)<br> enable_execute_command = optional(bool)<br> force_new_deployment = optional(bool, true)<br> health_check_grace_period_seconds = optional(number)<br> iam_role = optional(string)<br> propagate_tags = optional(string)<br> scheduling_strategy = optional(string)<br> triggers = optional(map(string))<br> wait_for_steady_state = optional(bool)<br> load_balancer = optional(any)<br> network_configuration = optional(any)<br> service_connect_configuration = optional(any)<br> volume_configuration = optional(any)<br> deployment_circuit_breaker = optional(any)<br> service_registries = optional(any)<br> tags = optional(map(string), {})<br> })</pre> | n/a | yes |
52+
| <a name="input_task_definition"></a> [task\_definition](#input\_task\_definition) | ECS Task Definition to use for running tasks. | <pre>object({<br> container_definitions = any<br> family = string<br> cpu = optional(string)<br> execution_role_arn = optional(string)<br> ipc_mode = optional(string)<br> memory = optional(string)<br> network_mode = optional(string, "awsvpc")<br> pid_mode = optional(string)<br> skip_destroy = optional(bool)<br> task_role_arn = optional(string)<br> track_latest = optional(bool)<br> runtime_platform = optional(any)<br> volume = optional(any)<br> tags = optional(map(string), {})<br> })</pre> | n/a | yes |
5453
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The ID of the VPC. | `string` | n/a | yes |
5554

5655
## Outputs
@@ -73,5 +72,4 @@ Terraform module to deploy production-ready applications and services on an exis
7372
| <a name="output_capacity_provider_ids"></a> [capacity\_provider\_ids](#output\_capacity\_provider\_ids) | Identifiers for the ECS Capacity Providers. |
7473
| <a name="output_ecs_service_arn"></a> [ecs\_service\_arn](#output\_ecs\_service\_arn) | ARN that identifies the service. |
7574
| <a name="output_ecs_task_definition_arn"></a> [ecs\_task\_definition\_arn](#output\_ecs\_task\_definition\_arn) | Full ARN of the Task Definition. |
76-
| <a name="output_imported_acm_certificates_arns"></a> [imported\_acm\_certificates\_arns](#output\_imported\_acm\_certificates\_arns) | ARNs of the Imported ACM certificates. |
7775
<!-- END_TF_DOCS -->

modules/acm/README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,12 @@ No modules.
2222
| Name | Type |
2323
|------|------|
2424
| [aws_acm_certificate.amazon_issued](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acm_certificate) | resource |
25-
| [aws_acm_certificate.imported](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acm_certificate) | resource |
2625

2726
## Inputs
2827

2928
| Name | Description | Type | Default | Required |
3029
|------|-------------|------|---------|:--------:|
3130
| <a name="input_amazon_issued_certificates"></a> [amazon\_issued\_certificates](#input\_amazon\_issued\_certificates) | List of Amazon-issued certificates to ACM create. | <pre>map(object({<br> domain_name = string<br> subject_alternative_names = optional(list(string), [])<br> validation_method = optional(string, null)<br> key_algorithm = optional(string, null)<br> validation_option = optional(object({<br> domain_name = string<br> validation_domain = string<br> }))<br> tags = optional(map(string), {})<br> }))</pre> | `{}` | no |
32-
| <a name="input_imported_certificates"></a> [imported\_certificates](#input\_imported\_certificates) | List of imported certificates to use to create ACM certificates. | <pre>map(object({<br> private_key = string<br> certificate_body = string<br> certificate_chain = optional(string, null)<br> tags = optional(map(string), {})<br> }))</pre> | `{}` | no |
3331
| <a name="input_tags"></a> [tags](#input\_tags) | (Optional) Map of tags to assign to the resource. | `map(string)` | `{}` | no |
3432

3533
## Outputs
@@ -38,5 +36,4 @@ No modules.
3836
|------|-------------|
3937
| <a name="output_amazon_issued_acm_certificates_arns"></a> [amazon\_issued\_acm\_certificates\_arns](#output\_amazon\_issued\_acm\_certificates\_arns) | ARNs of the Amazon issued ACM certificates. |
4038
| <a name="output_amazon_issued_acm_certificates_validation_records"></a> [amazon\_issued\_acm\_certificates\_validation\_records](#output\_amazon\_issued\_acm\_certificates\_validation\_records) | Validation Records of the Amazon issued ACM certificates. |
41-
| <a name="output_imported_acm_certificates_arns"></a> [imported\_acm\_certificates\_arns](#output\_imported\_acm\_certificates\_arns) | ARNs of the Imported ACM certificates. |
4239
<!-- END_TF_DOCS -->

modules/alb/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ No modules.
3333
| <a name="input_enable_deletion_protection"></a> [enable\_deletion\_protection](#input\_enable\_deletion\_protection) | (Optional) If true, deletion of the load balancer will be disabled via the AWS API. | `bool` | `false` | no |
3434
| <a name="input_internal"></a> [internal](#input\_internal) | (Optional) If true, the LB will be internal. | `bool` | `false` | no |
3535
| <a name="input_listener_rules"></a> [listener\_rules](#input\_listener\_rules) | Listener rules to associate with the the ALB Listeners. | <pre>map(object({<br> listener = string<br> priority = optional(number)<br> action = list(object({<br> type = string<br> authenticate_oidc = optional(object({<br> authorization_endpoint = string<br> client_id = string<br> client_secret = string<br> issuer = string<br> on_unauthenticated_request = optional(string)<br> scope = optional(string)<br> session_cookie_name = optional(string)<br> token_endpoint = string<br> user_info_endpoint = string<br> }))<br> target_group = optional(string)<br> }))<br> condition = set(object({<br> host_header = optional(object({<br> values = set(string)<br> }))<br> path_pattern = optional(object({<br> values = set(string)<br> }))<br> http_request_method = optional(object({<br> values = set(string)<br> }))<br> }))<br> tags = optional(map(string), {})<br> }))</pre> | `{}` | no |
36-
| <a name="input_listeners"></a> [listeners](#input\_listeners) | Listeners to forward ALB ingress to desired Target Groups. | <pre>map(object({<br> default_action = list(object({<br> type = string<br> target_group = string<br> fixed_response = optional(any, null)<br> forward = optional(any, null)<br> order = optional(number)<br> redirect = optional(any, null)<br> }))<br> certificate_arn = optional(string)<br> port = optional(number)<br> protocol = optional(string)<br> ssl_policy = optional(string)<br> tags = optional(map(string), {})<br> }))</pre> | n/a | yes |
36+
| <a name="input_listeners"></a> [listeners](#input\_listeners) | Listeners to forward ALB ingress to desired Target Groups. | <pre>map(object({<br> default_action = list(object({<br> type = string<br> target_group = string<br> fixed_response = optional(any, null)<br> forward = optional(any, null)<br> order = optional(number)<br> redirect = optional(any, null)<br> }))<br> certificate_arn = optional(string)<br> port = optional(number)<br> protocol = optional(string, "HTTP")<br> ssl_policy = optional(string, "ELBSecurityPolicy-TLS13-1-2-2021-06")<br> tags = optional(map(string), {})<br> }))</pre> | n/a | yes |
3737
| <a name="input_name"></a> [name](#input\_name) | (Optional) Name of the LB. | `string` | `""` | no |
3838
| <a name="input_preserve_host_header"></a> [preserve\_host\_header](#input\_preserve\_host\_header) | (Optional) Whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. | `bool` | `false` | no |
3939
| <a name="input_security_groups_ids"></a> [security\_groups\_ids](#input\_security\_groups\_ids) | (Optional) List of security group IDs to assign to the LB. | `list(string)` | `[]` | no |

0 commit comments

Comments
 (0)