Skip to content

Commit d2ed809

Browse files
terraform-docs: automated action
1 parent 24a6b1b commit d2ed809

File tree

1 file changed

+49
-51
lines changed

1 file changed

+49
-51
lines changed

README.md

+49-51
Original file line numberDiff line numberDiff line change
@@ -9,73 +9,71 @@ Currently we're aware of a bug occurring when trying to change container ports.
99
You can do this by commenting out the entire module, running a terraform apply, then uncommenting the module and running a terraform apply again after you've updated the container port.
1010

1111
<!-- BEGIN_TF_DOCS -->
12-
1312
## Requirements
1413

15-
| Name | Version |
16-
| ------------------------------------------------------ | ------- |
17-
| <a name="requirement_aws"></a> [aws](#requirement_aws) | >= 4.0 |
14+
| Name | Version |
15+
|------|---------|
16+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0 |
1817

1918
## Providers
2019

21-
| Name | Version |
22-
| ------------------------------------------------ | ------- |
23-
| <a name="provider_aws"></a> [aws](#provider_aws) | >= 4.0 |
20+
| Name | Version |
21+
|------|---------|
22+
| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0 |
2423

2524
## Modules
2625

27-
| Name | Source | Version |
28-
| ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ------- |
29-
| <a name="module_database"></a> [database](#module_database) | git::https://github.com/synapsestudios/terraform-aws-rds-aurora-cluster.git | v0.0.7 |
30-
| <a name="module_service_container_definition"></a> [service_container_definition](#module_service_container_definition) | cloudposse/ecs-container-definition/aws | 0.58.1 |
26+
| Name | Source | Version |
27+
|------|--------|---------|
28+
| <a name="module_database"></a> [database](#module\_database) | git::https://github.com/synapsestudios/terraform-aws-rds-aurora-cluster.git | v0.0.7 |
29+
| <a name="module_service_container_definition"></a> [service\_container\_definition](#module\_service\_container\_definition) | cloudposse/ecs-container-definition/aws | 0.58.1 |
3130

3231
## Resources
3332

34-
| Name | Type |
35-
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
36-
| [aws_cloudwatch_log_group.service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
37-
| [aws_ecs_service.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |
38-
| [aws_ecs_task_definition.service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
39-
| [aws_iam_role.ecs_task_execution_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
40-
| [aws_iam_role.ecs_task_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
41-
| [aws_iam_role_policy_attachment.cognito](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
42-
| [aws_iam_role_policy_attachment.ecs_task_execution_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
43-
| [aws_iam_role_policy_attachment.s3](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
44-
| [aws_iam_role_policy_attachment.secrets_manager](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
45-
| [aws_iam_role_policy_attachment.ses](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
46-
| [aws_lb_listener_rule.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |
47-
| [aws_lb_target_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource |
48-
| [aws_security_group.ecs_task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
49-
| [aws_security_group_rule.ecs_task_alb_access](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |
50-
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
51-
| [aws_iam_policy_document.assume_ecs_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
52-
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
33+
| Name | Type |
34+
|------|------|
35+
| [aws_cloudwatch_log_group.service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/cloudwatch_log_group) | resource |
36+
| [aws_ecs_service.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service) | resource |
37+
| [aws_ecs_task_definition.service](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition) | resource |
38+
| [aws_iam_role.ecs_task_execution_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
39+
| [aws_iam_role.ecs_task_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
40+
| [aws_iam_role_policy_attachment.cognito](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
41+
| [aws_iam_role_policy_attachment.ecs_task_execution_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
42+
| [aws_iam_role_policy_attachment.s3](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
43+
| [aws_iam_role_policy_attachment.secrets_manager](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
44+
| [aws_iam_role_policy_attachment.ses](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
45+
| [aws_lb_listener_rule.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_listener_rule) | resource |
46+
| [aws_lb_target_group.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lb_target_group) | resource |
47+
| [aws_security_group.ecs_task](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |
48+
| [aws_security_group_rule.ecs_task_alb_access](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |
49+
| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
50+
| [aws_iam_policy_document.assume_ecs_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
51+
| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
5352

5453
## Inputs
5554

56-
| Name | Description | Type | Default | Required |
57-
| ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------- | :------: |
58-
| <a name="input_alb_security_group_id"></a> [alb_security_group_id](#input_alb_security_group_id) | Security Group ID for the ALB | `string` | n/a | yes |
59-
| <a name="input_azs"></a> [azs](#input_azs) | Availability zones | `list(string)` | n/a | yes |
60-
| <a name="input_cluster_arn"></a> [cluster_arn](#input_cluster_arn) | ECS cluster to deploy into | `string` | n/a | yes |
61-
| <a name="input_command"></a> [command](#input_command) | Container startup command | `list(string)` | n/a | yes |
62-
| <a name="input_container_port"></a> [container_port](#input_container_port) | Port exposed by the container | `number` | n/a | yes |
63-
| <a name="input_container_secrets"></a> [container_secrets](#input_container_secrets) | The Secrets to Pass to the container. | <pre>list(object({<br> name = string<br> valueFrom = string<br> }))</pre> | `[]` | no |
64-
| <a name="input_ecr_host"></a> [ecr_host](#input_ecr_host) | Hostname of the ECR repository with no trailing slash | `string` | n/a | yes |
65-
| <a name="input_ecs_desired_count"></a> [ecs_desired_count](#input_ecs_desired_count) | How many tasks to launch in ECS service | `number` | `1` | no |
66-
| <a name="input_environment_variables"></a> [environment_variables](#input_environment_variables) | The environment variables to pass to the container. This is a list of maps. | <pre>list(object({<br> name = string<br> value = string<br> }))</pre> | `[]` | no |
67-
| <a name="input_health_check_path"></a> [health_check_path](#input_health_check_path) | Path to use for health checks | `string` | n/a | yes |
68-
| <a name="input_host_port"></a> [host_port](#input_host_port) | Port exposed by the host | `number` | `null` | no |
69-
| <a name="input_hostname"></a> [hostname](#input_hostname) | Hostname to use for listener rule | `string` | n/a | yes |
70-
| <a name="input_listener_arn"></a> [listener_arn](#input_listener_arn) | ALB listener ARN to add listener rule to | `string` | n/a | yes |
71-
| <a name="input_service_name"></a> [service_name](#input_service_name) | Service directory in the application git repo | `string` | n/a | yes |
72-
| <a name="input_subnets"></a> [subnets](#input_subnets) | List of subnet names the service will reside on. | `list(string)` | n/a | yes |
73-
| <a name="input_use_database_cluster"></a> [use_database_cluster](#input_use_database_cluster) | Whether or not we should create a DB cluster and inject the database connection string into the container | `bool` | n/a | yes |
74-
| <a name="input_use_hostname"></a> [use_hostname](#input_use_hostname) | Whether or not we should create a target group and listener to attach this service to a load balancer | `bool` | n/a | yes |
75-
| <a name="input_vpc_id"></a> [vpc_id](#input_vpc_id) | VPC to deploy into | `string` | n/a | yes |
55+
| Name | Description | Type | Default | Required |
56+
|------|-------------|------|---------|:--------:|
57+
| <a name="input_alb_security_group_id"></a> [alb\_security\_group\_id](#input\_alb\_security\_group\_id) | Security Group ID for the ALB | `string` | n/a | yes |
58+
| <a name="input_azs"></a> [azs](#input\_azs) | Availability zones | `list(string)` | n/a | yes |
59+
| <a name="input_cluster_arn"></a> [cluster\_arn](#input\_cluster\_arn) | ECS cluster to deploy into | `string` | n/a | yes |
60+
| <a name="input_command"></a> [command](#input\_command) | Container startup command | `list(string)` | n/a | yes |
61+
| <a name="input_container_port"></a> [container\_port](#input\_container\_port) | Port exposed by the container | `number` | n/a | yes |
62+
| <a name="input_container_secrets"></a> [container\_secrets](#input\_container\_secrets) | The Secrets to Pass to the container. | <pre>list(object({<br> name = string<br> valueFrom = string<br> }))</pre> | `[]` | no |
63+
| <a name="input_ecr_host"></a> [ecr\_host](#input\_ecr\_host) | Hostname of the ECR repository with no trailing slash | `string` | n/a | yes |
64+
| <a name="input_ecs_desired_count"></a> [ecs\_desired\_count](#input\_ecs\_desired\_count) | How many tasks to launch in ECS service | `number` | `1` | no |
65+
| <a name="input_environment_variables"></a> [environment\_variables](#input\_environment\_variables) | The environment variables to pass to the container. This is a list of maps. | <pre>list(object({<br> name = string<br> value = string<br> }))</pre> | `[]` | no |
66+
| <a name="input_health_check_path"></a> [health\_check\_path](#input\_health\_check\_path) | Path to use for health checks | `string` | n/a | yes |
67+
| <a name="input_host_port"></a> [host\_port](#input\_host\_port) | Port exposed by the host | `number` | `null` | no |
68+
| <a name="input_hostname"></a> [hostname](#input\_hostname) | Hostname to use for listener rule | `string` | n/a | yes |
69+
| <a name="input_listener_arn"></a> [listener\_arn](#input\_listener\_arn) | ALB listener ARN to add listener rule to | `string` | n/a | yes |
70+
| <a name="input_service_name"></a> [service\_name](#input\_service\_name) | Service directory in the application git repo | `string` | n/a | yes |
71+
| <a name="input_subnets"></a> [subnets](#input\_subnets) | List of subnet names the service will reside on. | `list(string)` | n/a | yes |
72+
| <a name="input_use_database_cluster"></a> [use\_database\_cluster](#input\_use\_database\_cluster) | Whether or not we should create a DB cluster and inject the database connection string into the container | `bool` | n/a | yes |
73+
| <a name="input_use_hostname"></a> [use\_hostname](#input\_use\_hostname) | Whether or not we should create a target group and listener to attach this service to a load balancer | `bool` | n/a | yes |
74+
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | VPC to deploy into | `string` | n/a | yes |
7675

7776
## Outputs
7877

7978
No outputs.
80-
8179
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)