Skip to content

Commit 870f8e6

Browse files
terraform-docs: automated action
1 parent bf21260 commit 870f8e6

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Terraform module to deploy production-ready applications and services on an exis
4141

4242
| Name | Description | Type | Default | Required |
4343
|------|-------------|------|---------|:--------:|
44-
| <a name="input_acm_certificates"></a> [acm\_certificates](#input\_acm\_certificates) | ACM certificates to create. | <pre>map(object({<br> domain_name = string<br> subject_alternative_names = optional(list(string), [])<br> validation_method = optional(string, "DNS")<br> key_algorithm = optional(string, "RSA_2048")<br> validation_option = optional(object({<br> domain_name = string<br> validation_domain = string<br> }))<br> tags = optional(map(string), {})<br> record_zone_id = string<br> record_allow_overwrite = optional(bool, true)<br> }))</pre> | `{}` | no |
44+
| <a name="input_acm_certificates"></a> [acm\_certificates](#input\_acm\_certificates) | ACM certificates to create. | <pre>map(object({<br/> domain_name = string<br/> subject_alternative_names = optional(list(string), [])<br/> validation_method = optional(string, "DNS")<br/> key_algorithm = optional(string, "RSA_2048")<br/> validation_option = optional(object({<br/> domain_name = string<br/> validation_domain = string<br/> }))<br/> tags = optional(map(string), {})<br/> record_zone_id = string<br/> record_allow_overwrite = optional(bool, true)<br/> }))</pre> | `{}` | no |
4545
| <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 |
4646
| <a name="input_capacity_providers"></a> [capacity\_providers](#input\_capacity\_providers) | Capacity Providers to associate with the ECS Cluster. | `any` | `{}` | no |
4747
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | (Required) Name of the cluster. | `string` | n/a | yes |
@@ -50,14 +50,14 @@ Terraform module to deploy production-ready applications and services on an exis
5050
| <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 |
5151
| <a name="input_create_s3_bucket_for_alb_logging"></a> [create\_s3\_bucket\_for\_alb\_logging](#input\_create\_s3\_bucket\_for\_alb\_logging) | (Optional) Creates S3 bucket for storing ALB Access and Connection Logs. | `bool` | `true` | no |
5252
| <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 |
53-
| <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> access_logs = optional(any, null)<br> connection_logs = optional(any, null)<br> target_groups = optional(any, {})<br> listeners = optional(any, {})<br> listener_rules = optional(any, {})<br> tags = optional(map(string), {})<br> })</pre> | `{}` | no |
53+
| <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/> access_logs = optional(any, null)<br/> connection_logs = optional(any, null)<br/> target_groups = optional(any, {})<br/> listeners = optional(any, {})<br/> listener_rules = optional(any, {})<br/> tags = optional(map(string), {})<br/> })</pre> | `{}` | no |
5454
| <a name="input_s3_bucket_force_destroy"></a> [s3\_bucket\_force\_destroy](#input\_s3\_bucket\_force\_destroy) | (Optional, Default:false) Boolean that indicates all objects (including any locked objects) should be deleted from the bucket when the bucket is destroyed so that the bucket can be destroyed without error. | `bool` | `false` | no |
5555
| <a name="input_s3_bucket_name"></a> [s3\_bucket\_name](#input\_s3\_bucket\_name) | (Optional, Forces new resource) Name of the bucket. | `string` | `null` | no |
5656
| <a name="input_s3_bucket_policy_id_prefix"></a> [s3\_bucket\_policy\_id\_prefix](#input\_s3\_bucket\_policy\_id\_prefix) | (Optional) - Prefix of the ID for the policy document. | `string` | `"ecs-deployment-alb-"` | no |
5757
| <a name="input_s3_bucket_tags"></a> [s3\_bucket\_tags](#input\_s3\_bucket\_tags) | (Optional) Map of tags to assign to the bucket. | `map(string)` | `{}` | no |
5858
| <a name="input_s3_elb_service_account_arn"></a> [s3\_elb\_service\_account\_arn](#input\_s3\_elb\_service\_account\_arn) | (Optional, Default:null) ARN of the ELB Service Account. | `string` | `null` | no |
59-
| <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, null)<br> service_connect_configuration = optional(any, null)<br> volume_configuration = optional(any, null)<br> deployment_circuit_breaker = optional(any, null)<br> service_registries = optional(any, null)<br> tags = optional(map(string), {})<br> })</pre> | n/a | yes |
60-
| <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, null)<br> volume = optional(any, null)<br> tags = optional(map(string), {})<br> })</pre> | n/a | yes |
59+
| <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, null)<br/> service_connect_configuration = optional(any, null)<br/> volume_configuration = optional(any, null)<br/> deployment_circuit_breaker = optional(any, null)<br/> service_registries = optional(any, null)<br/> tags = optional(map(string), {})<br/> })</pre> | n/a | yes |
60+
| <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, null)<br/> volume = optional(any, null)<br/> tags = optional(map(string), {})<br/> })</pre> | n/a | yes |
6161
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The ID of the VPC. | `string` | n/a | yes |
6262

6363
## Outputs

modules/acm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ No modules.
5151
| <a name="input_certificate_key_algorithm"></a> [certificate\_key\_algorithm](#input\_certificate\_key\_algorithm) | (Optional) Specifies the algorithm of the public and private key pair that your Amazon issued certificate uses to encrypt data. | `string` | `"RSA_2048"` | no |
5252
| <a name="input_certificate_subject_alternative_names"></a> [certificate\_subject\_alternative\_names](#input\_certificate\_subject\_alternative\_names) | (Optional) Set of domains that should be SANs in the issued certificate. | `list(string)` | `[]` | no |
5353
| <a name="input_certificate_validation_method"></a> [certificate\_validation\_method](#input\_certificate\_validation\_method) | (Optional) Which method to use for validation. DNS or EMAIL are valid. | `string` | `"DNS"` | no |
54-
| <a name="input_certificate_validation_option"></a> [certificate\_validation\_option](#input\_certificate\_validation\_option) | (Optional) Configuration block used to specify information about the initial validation of each domain name. | <pre>object({<br> domain_name = string<br> validation_domain = string<br> })</pre> | `null` | no |
54+
| <a name="input_certificate_validation_option"></a> [certificate\_validation\_option](#input\_certificate\_validation\_option) | (Optional) Configuration block used to specify information about the initial validation of each domain name. | <pre>object({<br/> domain_name = string<br/> validation_domain = string<br/> })</pre> | `null` | no |
5555
| <a name="input_record_allow_overwrite"></a> [record\_allow\_overwrite](#input\_record\_allow\_overwrite) | (Optional) Allow creation of this record in Terraform to overwrite an existing record, if any. | `bool` | `true` | no |
5656
| <a name="input_record_zone_id"></a> [record\_zone\_id](#input\_record\_zone\_id) | (Required) Hosted zone ID for a CloudFront distribution, S3 bucket, ELB, or Route 53 hosted zone. | `string` | n/a | yes |
5757
| <a name="input_tags"></a> [tags](#input\_tags) | (Optional) Map of tags to assign to the resource. | `map(string)` | `{}` | no |

modules/alb/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,18 +81,18 @@ No modules.
8181

8282
| Name | Description | Type | Default | Required |
8383
|------|-------------|------|---------|:--------:|
84-
| <a name="input_access_logs"></a> [access\_logs](#input\_access\_logs) | (Optional) Access Logs block. | <pre>object({<br> bucket = string<br> enabled = optional(bool, true)<br> prefix = optional(string, null)<br> })</pre> | `null` | no |
85-
| <a name="input_connection_logs"></a> [connection\_logs](#input\_connection\_logs) | (Optional) Connection Logs block. | <pre>object({<br> bucket = string<br> enabled = optional(bool, false)<br> prefix = optional(string, null)<br> })</pre> | `null` | no |
84+
| <a name="input_access_logs"></a> [access\_logs](#input\_access\_logs) | (Optional) Access Logs block. | <pre>object({<br/> bucket = string<br/> enabled = optional(bool, true)<br/> prefix = optional(string, null)<br/> })</pre> | `null` | no |
85+
| <a name="input_connection_logs"></a> [connection\_logs](#input\_connection\_logs) | (Optional) Connection Logs block. | <pre>object({<br/> bucket = string<br/> enabled = optional(bool, false)<br/> prefix = optional(string, null)<br/> })</pre> | `null` | no |
8686
| <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 |
8787
| <a name="input_internal"></a> [internal](#input\_internal) | (Optional) If true, the LB will be internal. | `bool` | `false` | no |
88-
| <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 |
89-
| <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, null)<br> tags = optional(map(string), {})<br> }))</pre> | `{}` | no |
88+
| <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 |
89+
| <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, null)<br/> tags = optional(map(string), {})<br/> }))</pre> | `{}` | no |
9090
| <a name="input_name"></a> [name](#input\_name) | (Optional) Name of the LB. | `string` | `null` | no |
9191
| <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` | `true` | no |
9292
| <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 |
9393
| <a name="input_subnets_ids"></a> [subnets\_ids](#input\_subnets\_ids) | (Optional) List of subnet IDs to attach to the LB. | `list(string)` | n/a | yes |
9494
| <a name="input_tags"></a> [tags](#input\_tags) | (Optional) Map of tags to assign to the resource. | `map(string)` | `{}` | no |
95-
| <a name="input_target_groups"></a> [target\_groups](#input\_target\_groups) | Target Groups to create and forward ALB ingress to. | <pre>map(object({<br> name = optional(string)<br> vpc_id = optional(string)<br> port = optional(number)<br> protocol = optional(string)<br> target_type = optional(string)<br> health_check = optional(any, null)<br> tags = optional(map(string), {})<br> }))</pre> | `{}` | no |
95+
| <a name="input_target_groups"></a> [target\_groups](#input\_target\_groups) | Target Groups to create and forward ALB ingress to. | <pre>map(object({<br/> name = optional(string)<br/> vpc_id = optional(string)<br/> port = optional(number)<br/> protocol = optional(string)<br/> target_type = optional(string)<br/> health_check = optional(any, null)<br/> tags = optional(map(string), {})<br/> }))</pre> | `{}` | no |
9696

9797
## Outputs
9898

0 commit comments

Comments
 (0)