Skip to content

Commit caab893

Browse files
terraform-docs: automated action
1 parent e03488b commit caab893

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ Terraform module to deploy production-ready applications and services on an exis
2727
| <a name="module_acm"></a> [acm](#module\_acm) | ./modules/acm | n/a |
2828
| <a name="module_alb"></a> [alb](#module\_alb) | ./modules/alb | n/a |
2929
| <a name="module_capacity_provider"></a> [capacity\_provider](#module\_capacity\_provider) | ./modules/capacity-provider | n/a |
30+
| <a name="module_s3_bucket"></a> [s3\_bucket](#module\_s3\_bucket) | ./modules/s3-bucket | n/a |
3031

3132
## Resources
3233

3334
| Name | Type |
3435
|------|------|
3536
| [aws_ecs_service.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |
3637
| [aws_ecs_task_definition.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
38+
| [aws_elb_service_account.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/elb_service_account) | data source |
3739

3840
## Inputs
3941

@@ -46,8 +48,15 @@ Terraform module to deploy production-ready applications and services on an exis
4648
| <a name="input_create_acm"></a> [create\_acm](#input\_create\_acm) | Creates the ACM certificates to use with the Load Balancer. | `bool` | `false` | no |
4749
| <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 |
4850
| <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 |
51+
| <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 |
4952
| <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 |
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 |
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 |
54+
| <a name="input_s3_bucket_access_logs_prefix"></a> [s3\_bucket\_access\_logs\_prefix](#input\_s3\_bucket\_access\_logs\_prefix) | (Optional) - Prefix for storing ALB access logs in the S3 bucket. | `string` | `"alb-access-logs"` | no |
55+
| <a name="input_s3_bucket_connection_logs_prefix"></a> [s3\_bucket\_connection\_logs\_prefix](#input\_s3\_bucket\_connection\_logs\_prefix) | (Optional) - Prefix for storing ALB connection logs in the S3 bucket. | `string` | `"alb-connection-logs"` | no |
56+
| <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 |
57+
| <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 |
58+
| <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 |
59+
| <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 |
5160
| <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 |
5261
| <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 |
5362
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The ID of the VPC. | `string` | n/a | yes |
@@ -74,4 +83,6 @@ Terraform module to deploy production-ready applications and services on an exis
7483
| <a name="output_capacity_provider_ids"></a> [capacity\_provider\_ids](#output\_capacity\_provider\_ids) | Identifiers for the ECS Capacity Providers. |
7584
| <a name="output_ecs_service_arn"></a> [ecs\_service\_arn](#output\_ecs\_service\_arn) | ARN that identifies the service. |
7685
| <a name="output_ecs_task_definition_arn"></a> [ecs\_task\_definition\_arn](#output\_ecs\_task\_definition\_arn) | Full ARN of the Task Definition. |
86+
| <a name="output_s3_bucket_arn"></a> [s3\_bucket\_arn](#output\_s3\_bucket\_arn) | ARN of the bucket. |
87+
| <a name="output_s3_bucket_id"></a> [s3\_bucket\_id](#output\_s3\_bucket\_id) | Name of the bucket. |
7788
<!-- END_TF_DOCS -->

modules/alb/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
This sub-module creates:
55

6-
1. Application Load Balancer in the given subnets
6+
1. Application Load Balancer in the given subnets with logging configuration
77
2. Target Groups with Health Check configuration
88
3. Listeners with Default Action configuration, and
99
4. Listener Rules with Actions with `forward` and `authenticate-oidc` types, and Conditions involving `host_header`, `path_pattern`, and `http_request_method`.

0 commit comments

Comments
 (0)