Skip to content

Commit e484704

Browse files
terraform-docs: automated action
1 parent 502a14c commit e484704

File tree

4 files changed

+7
-4
lines changed

4 files changed

+7
-4
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Terraform module to deploy production-ready applications and services on an exis
5757
| <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 |
5858
| <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 |
5959
| <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 |
60+
| <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 |
6061
| <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 |
6162
| <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 |
6263
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The ID of the VPC. | `string` | n/a | yes |

modules/acm/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ This sub-module creates the Amazon-issued certificate for a given domain with `v
88
### ACM Certificate
99

1010
- The `validation_method` is set to `DNS` as the recommended method, and can be overridden to use `EMAIL` method if required.
11+
- The `validation_method` is not marked as nullable, and is a required attribute for Amazon-issued ACM certificates.
12+
- The `key_algorithm` is set to `RSA_2048` as the default algorithm, and can be overridden to specify a different algorithm if required.
1113

1214
### Route53 Record
1315

@@ -46,7 +48,7 @@ No modules.
4648
| Name | Description | Type | Default | Required |
4749
|------|-------------|------|---------|:--------:|
4850
| <a name="input_certificate_domain_name"></a> [certificate\_domain\_name](#input\_certificate\_domain\_name) | (Required) Domain name for which the certificate should be issued. | `string` | n/a | yes |
49-
| <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` | `null` | no |
51+
| <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 |
5052
| <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 |
5153
| <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 |
5254
| <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 |

modules/alb/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ No modules.
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 |
8888
| <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, "ELBSecurityPolicy-TLS13-1-2-2021-06")<br> tags = optional(map(string), {})<br> }))</pre> | n/a | yes |
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, "ELBSecurityPolicy-TLS13-1-2-2021-06")<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 |

modules/capacity-provider/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This sub-module creates:
1010

1111
### ECS Capacity Provider
1212

13-
- The `managed_termination_protection` is enabled by default as recommended (which enables termination protection to container instances), and can be disabled if required.
13+
- The `managed_termination_protection` is disabled by default as recommended (which enables termination protection to container instances), and can be enabled if required. (Note: Enabling this option requires the `protect_from_scale_in` to be enabled on the Autoscaling group.)
1414

1515
### ECS Cluster Capacity Providers
1616

@@ -49,7 +49,7 @@ No modules.
4949

5050
| Name | Description | Type | Default | Required |
5151
|------|-------------|------|---------|:--------:|
52-
| <a name="input_capacity_providers"></a> [capacity\_providers](#input\_capacity\_providers) | Capacity Providers to associate with the ECS Cluster. | <pre>map(object({<br> name = string<br> auto_scaling_group_arn = optional(string)<br> managed_scaling = optional(<br> object({<br> instance_warmup_period = optional(number)<br> status = optional(string)<br> target_capacity = optional(number)<br> minimum_scaling_step_size = optional(number)<br> maximum_scaling_step_size = optional(number)<br> })<br> )<br> managed_termination_protection = optional(string, "ENABLED")<br> tags = optional(map(string), {})<br> }))</pre> | `{}` | no |
52+
| <a name="input_capacity_providers"></a> [capacity\_providers](#input\_capacity\_providers) | Capacity Providers to associate with the ECS Cluster. | <pre>map(object({<br> name = string<br> auto_scaling_group_arn = optional(string)<br> managed_scaling = optional(<br> object({<br> instance_warmup_period = optional(number)<br> status = optional(string)<br> target_capacity = optional(number)<br> minimum_scaling_step_size = optional(number)<br> maximum_scaling_step_size = optional(number)<br> })<br> )<br> managed_termination_protection = optional(string, "DISABLED")<br> tags = optional(map(string), {})<br> }))</pre> | `{}` | no |
5353
| <a name="input_default_auto_scaling_group_arn"></a> [default\_auto\_scaling\_group\_arn](#input\_default\_auto\_scaling\_group\_arn) | ARN for this Auto Scaling Group. | `string` | n/a | yes |
5454
| <a name="input_default_capacity_provider_strategies"></a> [default\_capacity\_provider\_strategies](#input\_default\_capacity\_provider\_strategies) | (Optional) Set of capacity provider strategies to use by default for the cluster. | <pre>list(object({<br> capacity_provider = string<br> weight = optional(number, 1)<br> base = optional(number, 0)<br> }))</pre> | `[]` | no |
5555
| <a name="input_ecs_cluster_name"></a> [ecs\_cluster\_name](#input\_ecs\_cluster\_name) | (Required) Name of the cluster. | `string` | n/a | yes |

0 commit comments

Comments
 (0)