Skip to content

Commit 56e2f46

Browse files
committed
refactor(examples/complete): update README
1 parent dc1c123 commit 56e2f46

File tree

2 files changed

+25
-15
lines changed

2 files changed

+25
-15
lines changed

examples/complete/.header.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# ECS EC2 Complete
1+
# ECS Complete
22

33
Configuration in this directory creates:
44

55
- ECS Cluster using self-managed EC2
6-
- ECS Service configured for running Tasks on self-managed EC2
6+
- Autoscaling Group with self-managed EC2 for the created ECS Cluster
77

88
## Usage
99

examples/complete/README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,29 @@
1-
21
<!-- BEGIN_TF_DOCS -->
2+
# ECS Complete
3+
4+
Configuration in this directory creates:
5+
6+
- ECS Cluster using self-managed EC2
7+
- Autoscaling Group with self-managed EC2 for the created ECS Cluster
8+
9+
## Usage
10+
11+
To run this example, you will need to execute the commands:
12+
13+
```bash
14+
terraform init
15+
terraform plan
16+
terraform apply
17+
```
18+
19+
Please note that this example may create resources that can incur monetary charges on your AWS bill. You can run `terraform destroy` when you no longer need the resources.
20+
321
## Requirements
422

523
| Name | Version |
624
|------|---------|
7-
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.6.0 |
8-
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.57.0 |
25+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.8.4 |
26+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.51.0 |
927

1028
## Providers
1129

@@ -16,7 +34,6 @@ No providers.
1634
| Name | Source | Version |
1735
|------|--------|---------|
1836
| <a name="module_ecs"></a> [ecs](#module\_ecs) | ../../ | n/a |
19-
| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | ~> 5.9.0 |
2037

2138
## Resources
2239

@@ -30,13 +47,6 @@ No inputs.
3047

3148
| Name | Description |
3249
|------|-------------|
33-
| <a name="output_ecs_cluster_arn"></a> [ecs\_cluster\_arn](#output\_ecs\_cluster\_arn) | ARN of the ECS Cluster |
34-
| <a name="output_private_subnets"></a> [private\_subnets](#output\_private\_subnets) | Identifiers of the Private Subnets |
35-
| <a name="output_private_subnets_arns"></a> [private\_subnets\_arns](#output\_private\_subnets\_arns) | ARNs of the Private Subnets |
36-
| <a name="output_private_subnets_cidr_blocks"></a> [private\_subnets\_cidr\_blocks](#output\_private\_subnets\_cidr\_blocks) | CIDR Blocks of the Private Subnets |
37-
| <a name="output_public_subnets"></a> [public\_subnets](#output\_public\_subnets) | Identifiers of the Public Subnets |
38-
| <a name="output_public_subnets_arns"></a> [public\_subnets\_arns](#output\_public\_subnets\_arns) | ARNs of the Public Subnets |
39-
| <a name="output_public_subnets_cidr_blocks"></a> [public\_subnets\_cidr\_blocks](#output\_public\_subnets\_cidr\_blocks) | CIDR Blocks of the Public Subnets |
40-
| <a name="output_vpc_cidr_block"></a> [vpc\_cidr\_block](#output\_vpc\_cidr\_block) | CIDR Block of the VPC |
41-
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | Identifier of the VPC |
50+
| <a name="output_cluster_arn"></a> [cluster\_arn](#output\_cluster\_arn) | ARN that identifies the cluster. |
51+
| <a name="output_cluster_name"></a> [cluster\_name](#output\_cluster\_name) | Name of the ECS Cluster |
4252
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)