Skip to content

Commit 6e418bb

Browse files
arthurbdinizarthurbdiniz
committed
terraform-docs: automated update action
1 parent 88df4a1 commit 6e418bb

File tree

1 file changed

+41
-39
lines changed

1 file changed

+41
-39
lines changed

‎README.md

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ module "ecs_apps" {
5252

5353
| Name | Version |
5454
|------|---------|
55-
| terraform | >= 0.12.0 |
55+
| terraform | >= 0.13.0 |
5656

5757
## Providers
5858

@@ -66,50 +66,52 @@ module "ecs_apps" {
6666

6767
| Name | Description | Type | Default | Required |
6868
|------|-------------|------|---------|:--------:|
69-
| alarm\_alb\_400\_errors\_threshold | Max threshold of HTTP 4000 errors allowed in a 5 minutes interval (use 0 to disable this alarm) | `number` | `10` | no |
70-
| alarm\_alb\_500\_errors\_threshold | Max threshold of HTTP 500 errors allowed in a 5 minutes interval (use 0 to disable this alarm) | `number` | `10` | no |
71-
| alarm\_alb\_latency\_anomaly\_threshold | ALB Latency anomaly detection width (use 0 to disable this alarm) | `number` | `2` | no |
72-
| alarm\_asg\_high\_cpu\_threshold | Max threshold average CPU percentage allowed in a 2 minutes interval (use 0 to disable this alarm) | `number` | `80` | no |
73-
| alarm\_ecs\_high\_cpu\_threshold | Max threshold average CPU percentage allowed in a 2 minutes interval (use 0 to disable this alarm) | `number` | `80` | no |
74-
| alarm\_ecs\_high\_memory\_threshold | Max threshold average Memory percentage allowed in a 2 minutes interval (use 0 to disable this alarm) | `number` | `80` | no |
75-
| alarm\_efs\_credits\_low\_threshold | Alerts when EFS credits fell below this number in bytes - default 1000000000000 is 1TB of a maximum of 2.31T of credits (use 0 to disable this alarm) | `number` | `1000000000000` | no |
76-
| alarm\_prefix | String prefix for cloudwatch alarms. (Optional) | `string` | `""` | no |
77-
| alarm\_sns\_topics | Alarm topics to create and alert on ECS instance metrics | `list` | `[]` | no |
78-
| alb | Whether to deploy an ALB or not with the cluster | `bool` | `true` | no |
79-
| alb\_internal | Deploys a second internal ALB for private APIs | `bool` | `false` | no |
80-
| alb\_only | Whether to deploy only an alb and no cloudFront or not with the cluster | `bool` | `false` | no |
69+
| alarm\_alb\_400\_errors\_threshold | Max threshold of HTTP 4000 errors allowed in a 5 minutes interval (use 0 to disable this alarm). | `number` | `10` | no |
70+
| alarm\_alb\_500\_errors\_threshold | Max threshold of HTTP 500 errors allowed in a 5 minutes interval (use 0 to disable this alarm). | `number` | `10` | no |
71+
| alarm\_alb\_latency\_anomaly\_threshold | ALB Latency anomaly detection width (use 0 to disable this alarm). | `number` | `2` | no |
72+
| alarm\_asg\_high\_cpu\_threshold | Max threshold average CPU percentage allowed in a 2 minutes interval (use 0 to disable this alarm). | `number` | `80` | no |
73+
| alarm\_ecs\_high\_cpu\_threshold | Max threshold average CPU percentage allowed in a 2 minutes interval (use 0 to disable this alarm). | `number` | `80` | no |
74+
| alarm\_ecs\_high\_memory\_threshold | Max threshold average Memory percentage allowed in a 2 minutes interval (use 0 to disable this alarm). | `number` | `80` | no |
75+
| alarm\_efs\_credits\_low\_threshold | Alerts when EFS credits fell below this number in bytes - default 1000000000000 is 1TB of a maximum of 2.31T of credits (use 0 to disable this alarm). | `number` | `1000000000000` | no |
76+
| alarm\_prefix | String prefix for cloudwatch alarms. (Optional) | `string` | `"alarm"` | no |
77+
| alarm\_sns\_topics | Alarm topics to create and alert on ECS instance metrics. | `list` | `[]` | no |
78+
| alb | Whether to deploy an ALB or not with the cluster. | `bool` | `true` | no |
79+
| alb\_internal | Deploys a second internal ALB for private APIs. | `bool` | `false` | no |
80+
| alb\_only | Whether to deploy only an alb and no cloudFront or not with the cluster. | `bool` | `false` | no |
8181
| alb\_ssl\_policy | The name of the SSL Policy for the listener. Required if protocol is HTTPS or TLS. | `string` | `"ELBSecurityPolicy-2016-08"` | no |
8282
| architecture | Architecture to select the AMI, x86\_64 or arm64 | `string` | `"x86_64"` | no |
83-
| asg\_max | Max number of instances for autoscaling group | `number` | `4` | no |
84-
| asg\_memory\_target | Target average memory percentage to track for autoscaling | `number` | `60` | no |
85-
| asg\_min | Min number of instances for autoscaling group | `number` | `1` | no |
86-
| autoscaling\_default\_cooldown | The amount of time, in seconds, after a scaling activity completes before another scaling activity can start | `number` | `300` | no |
87-
| autoscaling\_health\_check\_grace\_period | The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service | `number` | `300` | no |
88-
| backup | Assing a backup tag to efs resource - Backup will be performed by AWS Backup | `string` | `"true"` | no |
83+
| asg\_max | Max number of instances for autoscaling group. | `number` | `4` | no |
84+
| asg\_min | Min number of instances for autoscaling group. | `number` | `1` | no |
85+
| asg\_protect\_from\_scale\_in | (Optional) Allows setting instance protection. The autoscaling group will not select instances with this setting for termination during scale in events. | `bool` | `false` | no |
86+
| asg\_target\_capacity | Target average capacity percentage for the ECS capacity provider to track for autoscaling. | `number` | `70` | no |
87+
| autoscaling\_default\_cooldown | The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. | `number` | `300` | no |
88+
| autoscaling\_health\_check\_grace\_period | The length of time that Auto Scaling waits before checking an instance's health status. The grace period begins when an instance comes into service. | `number` | `300` | no |
89+
| backup | Assing a backup tag to efs resource - Backup will be performed by AWS Backup. | `string` | `"true"` | no |
8990
| certificate\_arn | n/a | `any` | n/a | yes |
9091
| certificate\_internal\_arn | certificate arn for internal ALB. | `string` | `""` | no |
91-
| enable\_schedule | Enables schedule to shut down and start up instances outside business hours | `bool` | `false` | no |
92-
| instance\_type\_1 | Instance type for ECS workers (first priority) | `any` | n/a | yes |
93-
| instance\_type\_2 | Instance type for ECS workers (second priority) | `any` | n/a | yes |
94-
| instance\_type\_3 | Instance type for ECS workers (third priority) | `any` | n/a | yes |
95-
| instance\_volume\_size | Volume size for docker volume (in GB) | `number` | `30` | no |
92+
| enable\_schedule | Enables schedule to shut down and start up instances outside business hours. | `bool` | `false` | no |
93+
| instance\_type\_1 | Instance type for ECS workers (first priority). | `any` | n/a | yes |
94+
| instance\_type\_2 | Instance type for ECS workers (second priority). | `any` | n/a | yes |
95+
| instance\_type\_3 | Instance type for ECS workers (third priority). | `any` | n/a | yes |
96+
| instance\_volume\_size | Volume size for docker volume (in GB). | `number` | `22` | no |
97+
| instance\_volume\_size\_root | Volume size for root volume (in GB). | `number` | `16` | no |
9698
| kms\_key\_arn | ARN of a KMS Key to use on EFS and EBS volumes | `string` | `""` | no |
97-
| lb\_access\_logs\_bucket | Bucket to store logs from lb access | `string` | `""` | no |
98-
| lb\_access\_logs\_prefix | Bucket prefix to store lb access logs | `string` | `""` | no |
99-
| name | Name of this ECS cluster | `any` | n/a | yes |
99+
| lb\_access\_logs\_bucket | Bucket to store logs from lb access. | `string` | `""` | no |
100+
| lb\_access\_logs\_prefix | Bucket prefix to store lb access logs. | `string` | `""` | no |
101+
| name | Name of this ECS cluster. | `any` | n/a | yes |
100102
| on\_demand\_base\_capacity | You can designate a base portion of your total capacity as On-Demand. As the group scales, per your settings, the base portion is provisioned first, while additional On-Demand capacity is percentage-based. | `number` | `0` | no |
101-
| on\_demand\_percentage | Percentage of on-demand intances vs spot | `number` | `100` | no |
102-
| private\_subnet\_ids | List of private subnet IDs for ECS instances and Internal ALB when enabled | `list(string)` | n/a | yes |
103-
| provisioned\_throughput\_in\_mibps | The throughput, measured in MiB/s, that you want to provision for the file system | `number` | `0` | no |
104-
| public\_subnet\_ids | List of public subnet IDs for ECS ALB | `list(string)` | n/a | yes |
105-
| schedule\_cron\_start | Cron expression to define when to trigger a start of the auto-scaling group. E.g. '0 20 \* \* \*' to start at 8pm GMT time | `string` | `""` | no |
106-
| schedule\_cron\_stop | Cron expression to define when to trigger a stop of the auto-scaling group. E.g. '0 10 \* \* \*' to stop at 10am GMT time | `string` | `""` | no |
107-
| secure\_subnet\_ids | List of secure subnet IDs for EFS | `list(string)` | n/a | yes |
108-
| security\_group\_ids | Extra security groups for instances | `list(string)` | `[]` | no |
109-
| target\_group\_arns | List of target groups for ASG to register | `list(string)` | `[]` | no |
110-
| throughput\_mode | Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned | `string` | `"bursting"` | no |
111-
| userdata | Extra commands to pass to userdata | `string` | `""` | no |
112-
| vpc\_id | VPC ID to deploy the ECS cluster | `any` | n/a | yes |
103+
| on\_demand\_percentage | Percentage of on-demand intances vs spot. | `number` | `100` | no |
104+
| private\_subnet\_ids | List of private subnet IDs for ECS instances and Internal ALB when enabled. | `list(string)` | n/a | yes |
105+
| provisioned\_throughput\_in\_mibps | The throughput, measured in MiB/s, that you want to provision for the file system. | `number` | `0` | no |
106+
| public\_subnet\_ids | List of public subnet IDs for ECS ALB. | `list(string)` | n/a | yes |
107+
| schedule\_cron\_start | Cron expression to define when to trigger a start of the auto-scaling group. E.g. '0 20 \* \* \*' to start at 8pm GMT time. | `string` | `""` | no |
108+
| schedule\_cron\_stop | Cron expression to define when to trigger a stop of the auto-scaling group. E.g. '0 10 \* \* \*' to stop at 10am GMT time. | `string` | `""` | no |
109+
| secure\_subnet\_ids | List of secure subnet IDs for EFS. | `list(string)` | n/a | yes |
110+
| security\_group\_ids | Extra security groups for instances. | `list(string)` | `[]` | no |
111+
| target\_group\_arns | List of target groups for ASG to register. | `list(string)` | `[]` | no |
112+
| throughput\_mode | Throughput mode for the file system. Defaults to bursting. Valid values: bursting, provisioned. | `string` | `"bursting"` | no |
113+
| userdata | Extra commands to pass to userdata. | `string` | `""` | no |
114+
| vpc\_id | VPC ID to deploy the ECS cluster. | `any` | n/a | yes |
113115

114116
## Outputs
115117

0 commit comments

Comments
 (0)