Skip to content

Commit bce1550

Browse files
committed
chore: update README with tfdocs
1 parent f50333f commit bce1550

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,49 @@
1+
<!-- BEGIN_TF_DOCS -->
12
# terraform-aws-ecs-ec2
23

34
## Notice
45

56
This module depends on and includes configuration for the [terraform-aws-ecs](https://github.com/terraform-aws-modules/terraform-aws-ecs), which is licensed under the Apache License 2.0. You can find the original license in the `LICENSE` file of the public module.
7+
8+
## Requirements
9+
10+
| Name | Version |
11+
|------|---------|
12+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.4.6 |
13+
14+
## Providers
15+
16+
No providers.
17+
18+
## Modules
19+
20+
| Name | Source | Version |
21+
|------|--------|---------|
22+
| <a name="module_ecs_cluster"></a> [ecs\_cluster](#module\_ecs\_cluster) | terraform-aws-modules/ecs/aws//modules/cluster | ~> 5.11.3 |
23+
| <a name="module_ecs_service"></a> [ecs\_service](#module\_ecs\_service) | terraform-aws-modules/ecs/aws//modules/service | ~> 5.11.3 |
24+
25+
## Resources
26+
27+
No resources.
28+
29+
## Inputs
30+
31+
| Name | Description | Type | Default | Required |
32+
|------|-------------|------|---------|:--------:|
33+
| <a name="input_cluster_arn"></a> [cluster\_arn](#input\_cluster\_arn) | ARN of the ECS cluster under which the service will be created | `string` | `null` | no |
34+
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Name of the ECS Cluster to create | `string` | `""` | no |
35+
| <a name="input_cluster_tags"></a> [cluster\_tags](#input\_cluster\_tags) | Resource Tags for ECS Cluster | `map(any)` | `{}` | no |
36+
| <a name="input_create_cluster"></a> [create\_cluster](#input\_create\_cluster) | Creates an ECS cluster | `bool` | `true` | no |
37+
| <a name="input_service_cpu"></a> [service\_cpu](#input\_service\_cpu) | CPU allocation for ECS task definitions | `number` | n/a | yes |
38+
| <a name="input_service_memory"></a> [service\_memory](#input\_service\_memory) | Memory allocation for ECS task definitions | `number` | n/a | yes |
39+
| <a name="input_service_name"></a> [service\_name](#input\_service\_name) | Name of the ECS Service | `string` | n/a | yes |
40+
| <a name="input_service_subnet_ids"></a> [service\_subnet\_ids](#input\_service\_subnet\_ids) | VPC subnet ids where the ECS services will be deployed | `list(string)` | n/a | yes |
41+
| <a name="input_service_tags"></a> [service\_tags](#input\_service\_tags) | Resource Tags for ECS Service | `map(any)` | `{}` | no |
42+
43+
## Outputs
44+
45+
| Name | Description |
46+
|------|-------------|
47+
| <a name="output_cluster_arn"></a> [cluster\_arn](#output\_cluster\_arn) | ARN of the ECS Cluster |
48+
| <a name="output_service_id"></a> [service\_id](#output\_service\_id) | Identifier of the ECS Service |
49+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)