Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mbarrien committed Mar 24, 2020
1 parent 4204862 commit 9ed28a6
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion aws-acm-cert/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ module "cert" {
|------|-------------|------|---------|:-----:|
| allow\_validation\_record\_overwrite | Allow the overwrite of validation records. This is needed if you are creating certificates in multiple regions. | `string` | `true` | no |
| aws\_route53\_zone\_id | n/a | `string` | n/a | yes |
| cert\_domain\_name | Like www.foo.bar.com or \*.foo.bar.com | `string` | n/a | yes |
| cert\_domain\_name | Like www.foo.bar.com or *.foo.bar.com | `string` | n/a | yes |
| cert\_subject\_alternative\_names | A map of <alternative\_domain:route53\_zone\_id> | `map` | `{}` | no |
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
Expand Down
4 changes: 2 additions & 2 deletions aws-aurora-mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ No provider.
| database\_subnet\_group | The name of an existing database subnet group to use. | `string` | n/a | yes |
| database\_username | Default user to be created. | `string` | n/a | yes |
| db\_deletion\_protection | n/a | `string` | `false` | no |
| db\_parameters | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Instance) | `list` | <pre>[<br> {<br> "apply_method": "pending-reboot",<br> "name": "general_log",<br> "value": 1<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "slow_query_log",<br> "value": "1"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "long_query_time",<br> "value": "0"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "log_output",<br> "value": "file"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "log_queries_not_using_indexes",<br> "value": "1"<br> }<br>]<br></pre> | no |
| db\_parameters | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Instance) | `list` | <pre>[<br> {<br> "apply_method": "pending-reboot",<br> "name": "general_log",<br> "value": 1<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "slow_query_log",<br> "value": "1"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "long_query_time",<br> "value": "0"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "log_output",<br> "value": "file"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "log_queries_not_using_indexes",<br> "value": "1"<br> }<br>]</pre> | no |
| engine\_version | n/a | `string` | `"5.7"` | no |
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
| iam\_database\_authentication\_enabled | n/a | `string` | `false` | no |
Expand All @@ -60,7 +60,7 @@ No provider.
| performance\_insights\_enabled | n/a | `string` | `false` | no |
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | `string` | n/a | yes |
| publicly\_accessible | Avoid doing this - it gives access to the open internet. | `string` | `false` | no |
| rds\_cluster\_parameters | Cluster params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Cluster) | `list` | <pre>[<br> {<br> "apply_method": "pending-reboot",<br> "name": "character_set_server",<br> "value": "utf8"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "character_set_client",<br> "value": "utf8"<br> }<br>]<br></pre> | no |
| rds\_cluster\_parameters | Cluster params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Cluster) | `list` | <pre>[<br> {<br> "apply_method": "pending-reboot",<br> "name": "character_set_server",<br> "value": "utf8"<br> },<br> {<br> "apply_method": "pending-reboot",<br> "name": "character_set_client",<br> "value": "utf8"<br> }<br>]</pre> | no |
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
| skip\_final\_snapshot | When you destroy a database RDS will, by default, take snapshot. Set this to skip that step. | `string` | `false` | no |
| vpc\_id | The id of the existing VPC in which this cluster should be created. | `string` | n/a | yes |
Expand Down
6 changes: 3 additions & 3 deletions aws-ecs-service-fargate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,12 +166,12 @@ service = false` argument can be removed.
| extra\_tags | Extra tags that will be added to components created by this module. | `map(string)` | `{}` | no |
| health\_check\_grace\_period\_seconds | Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 7200. | `number` | `60` | no |
| health\_check\_interval | Time between health checks of the underlying service. | `number` | n/a | yes |
| health\_check\_matcher | Range of HTTP status codes considered success for health checks. [Doc](https://www.terraform.io/docs/providers/aws/r/lb\_target\_group.html#matcher) | `string` | `"200-399"` | no |
| health\_check\_matcher | Range of HTTP status codes considered success for health checks. [Doc](https://www.terraform.io/docs/providers/aws/r/lb_target_group.html#matcher) | `string` | `"200-399"` | no |
| health\_check\_path | n/a | `string` | `"/"` | no |
| health\_check\_timeout | Timeout for a health check of the underlying service. | `number` | n/a | yes |
| internal\_lb | n/a | `bool` | `false` | no |
| lb\_idle\_timeout\_seconds | n/a | `number` | `60` | no |
| lb\_ingress\_cidrs | n/a | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]<br></pre> | no |
| lb\_ingress\_cidrs | n/a | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| lb\_ingress\_security\_group\_ids | n/a | `list(string)` | `[]` | no |
| lb\_subnets | List of subnets in which to deploy the load balancer. | `list(string)` | n/a | yes |
| manage\_task\_definition | If false, Terraform will not touch the task definition for the ECS service after initial creation | `bool` | `true` | no |
Expand All @@ -186,7 +186,7 @@ service = false` argument can be removed.
| subdomain | Subdomain in the zone. Final domain name will be subdomain.zone | `string` | n/a | yes |
| tag\_service | Apply cost tags to the ECS service. Only specify false for backwards compatibility with old ECS services. | `bool` | `true` | no |
| task\_definition | JSON to describe task. If omitted, defaults to a stub task that is expected to be managed outside of Terraform. | `string` | n/a | yes |
| task\_egress\_cidrs | CIDRs the task is allowed to communicate with for outbound traffic. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]<br></pre> | no |
| task\_egress\_cidrs | CIDRs the task is allowed to communicate with for outbound traffic. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| task\_egress\_security\_group\_ids | Security groups the task is allowed to communicate with for outbound traffic. Only used if awsvpc\_network is true. | `list(string)` | `[]` | no |
| task\_role\_arn | n/a | `string` | n/a | yes |
| task\_subnets | List of subnets in which to deploy the task for awsvpc networking mode. | `list(string)` | `[]` | no |
Expand Down
6 changes: 3 additions & 3 deletions aws-ecs-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,12 +158,12 @@ service = false` argument can be removed.
| extra\_tags | Extra tags that will be added to components created by this module. | `map(string)` | `{}` | no |
| health\_check\_grace\_period\_seconds | Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 7200. | `number` | `60` | no |
| health\_check\_interval | Time between health checks of the underlying service. | `number` | n/a | yes |
| health\_check\_matcher | Range of HTTP status codes considered success for health checks. [Doc](https://www.terraform.io/docs/providers/aws/r/lb\_target\_group.html#matcher) | `string` | `"200-399"` | no |
| health\_check\_matcher | Range of HTTP status codes considered success for health checks. [Doc](https://www.terraform.io/docs/providers/aws/r/lb_target_group.html#matcher) | `string` | `"200-399"` | no |
| health\_check\_path | n/a | `string` | `"/"` | no |
| health\_check\_timeout | Timeout for a health check of the underlying service. | `number` | n/a | yes |
| internal\_lb | n/a | `bool` | `false` | no |
| lb\_idle\_timeout\_seconds | n/a | `number` | `60` | no |
| lb\_ingress\_cidrs | n/a | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]<br></pre> | no |
| lb\_ingress\_cidrs | n/a | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| lb\_ingress\_security\_group\_ids | n/a | `list(string)` | `[]` | no |
| lb\_subnets | List of subnets in which to deploy the load balancer. | `list(string)` | n/a | yes |
| manage\_task\_definition | If false, Terraform will not touch the task definition for the ECS service after initial creation | `bool` | `true` | no |
Expand All @@ -178,7 +178,7 @@ service = false` argument can be removed.
| subdomain | Subdomain in the zone. Final domain name will be subdomain.zone | `string` | n/a | yes |
| tag\_service | Apply cost tags to the ECS service. Only specify false for backwards compatibility with old ECS services. | `bool` | `true` | no |
| task\_definition | JSON to describe task. If omitted, defaults to a stub task that is expected to be managed outside of Terraform. | `string` | n/a | yes |
| task\_egress\_cidrs | CIDR blocks the task is allowed to communicate with for outbound traffic. Only used if awsvpc\_network\_mode is true. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]<br></pre> | no |
| task\_egress\_cidrs | CIDR blocks the task is allowed to communicate with for outbound traffic. Only used if awsvpc\_network\_mode is true. | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
| task\_egress\_security\_group\_ids | Security groups the task is allowed to communicate with for outbound traffic. Only used if awsvpc\_network\_mode is true. | `list(string)` | `[]` | no |
| task\_role\_arn | n/a | `string` | n/a | yes |
| task\_subnets | List of subnets in which to deploy the task for awsvpc networking mode. Only used if awsvpc\_network\_mode is true. | `list(string)` | `[]` | no |
Expand Down
2 changes: 1 addition & 1 deletion aws-iam-role-cloudfront-poweruser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This module will create a role which is granted poweruser control over AWS Cloud
|------|-------------|------|---------|:-----:|
| iam\_path | n/a | `string` | `"/"` | no |
| role\_name | Name of the role to create | `string` | n/a | yes |
| s3\_bucket\_prefixes | Limits role permissions to buckets with specific prefixes. Empty for all buckets. | `list` | <pre>[<br> ""<br>]<br></pre> | no |
| s3\_bucket\_prefixes | Limits role permissions to buckets with specific prefixes. Empty for all buckets. | `list` | <pre>[<br> ""<br>]</pre> | no |
| saml\_idp\_arn | The AWS SAML IDP arn to establish a trust relationship. Ignored if empty or not provided. | `string` | `""` | no |
| source\_account\_id | The source AWS account to establish a trust relationship. Ignored if empty or not provided. | `string` | `""` | no |

Expand Down

0 comments on commit 9ed28a6

Please sign in to comment.