Skip to content

Commit 14ec2cc

Browse files
mbarrienmbarrien
authored
Update docs to use Terraform docs v0.12.1 (#308)
Adds support for linking to Terraform providers
1 parent b8bacdb commit 14ec2cc

File tree

58 files changed

+1654
-904
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+1654
-904
lines changed

‎aws-acm-cert/README.md

+27-16
Original file line numberDiff line numberDiff line change
@@ -33,35 +33,46 @@ module "cert" {
3333

3434
| Name | Version |
3535
|------|---------|
36-
| aws | < 3.0.0 |
36+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | < 3.0.0 |
3737

3838
## Providers
3939

4040
| Name | Version |
4141
|------|---------|
42-
| aws | < 3.0.0 |
42+
| <a name="provider_aws"></a> [aws](#provider\_aws) | < 3.0.0 |
43+
44+
## Modules
45+
46+
No modules.
47+
48+
## Resources
49+
50+
| Name | Type |
51+
|------|------|
52+
| [aws_acm_certificate.cert](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acm_certificate) | resource |
53+
| [aws_acm_certificate_validation.cert](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/acm_certificate_validation) | resource |
54+
| [aws_route53_record.cert_validation](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |
4355

4456
## Inputs
4557

4658
| Name | Description | Type | Default | Required |
4759
|------|-------------|------|---------|:--------:|
48-
| allow\_validation\_record\_overwrite | Allow the overwrite of validation records. This is needed if you are creating certificates in multiple regions. | `string` | `true` | no |
49-
| aws\_route53\_zone\_id | n/a | `string` | n/a | yes |
50-
| cert\_domain\_name | Like www.foo.bar.com or \*.foo.bar.com | `string` | n/a | yes |
51-
| cert\_subject\_alternative\_names | A map of <alternative\_domain:route53\_zone\_id> | `map(string)` | `{}` | no |
52-
| cert\_subject\_alternative\_names\_count | The size of var.cert\_subject\_alternative\_names. Since var.cert\_subject\_alternative\_names can have dynamic keys/values we must hint terraform on its size. If you have no SANs then this should be 0. | `number` | `0` | no |
53-
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
54-
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
55-
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | `string` | n/a | yes |
56-
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
57-
| subject\_alternative\_names\_order | Order to list the subject alternative names in the ACM cert. Workaround for https://github.com/terraform-providers/terraform-provider-aws/issues/8531 | `list(string)` | `null` | no |
58-
| validation\_record\_ttl | n/a | `string` | `60` | no |
60+
| <a name="input_allow_validation_record_overwrite"></a> [allow\_validation\_record\_overwrite](#input\_allow\_validation\_record\_overwrite) | Allow the overwrite of validation records. This is needed if you are creating certificates in multiple regions. | `string` | `true` | no |
61+
| <a name="input_aws_route53_zone_id"></a> [aws\_route53\_zone\_id](#input\_aws\_route53\_zone\_id) | n/a | `string` | n/a | yes |
62+
| <a name="input_cert_domain_name"></a> [cert\_domain\_name](#input\_cert\_domain\_name) | Like www.foo.bar.com or *.foo.bar.com | `string` | n/a | yes |
63+
| <a name="input_cert_subject_alternative_names"></a> [cert\_subject\_alternative\_names](#input\_cert\_subject\_alternative\_names) | A map of <alternative\_domain:route53\_zone\_id> | `map(string)` | `{}` | no |
64+
| <a name="input_cert_subject_alternative_names_count"></a> [cert\_subject\_alternative\_names\_count](#input\_cert\_subject\_alternative\_names\_count) | The size of var.cert\_subject\_alternative\_names. Since var.cert\_subject\_alternative\_names can have dynamic keys/values we must hint terraform on its size. If you have no SANs then this should be 0. | `number` | `0` | no |
65+
| <a name="input_env"></a> [env](#input\_env) | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
66+
| <a name="input_owner"></a> [owner](#input\_owner) | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
67+
| <a name="input_project"></a> [project](#input\_project) | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | `string` | n/a | yes |
68+
| <a name="input_service"></a> [service](#input\_service) | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
69+
| <a name="input_subject_alternative_names_order"></a> [subject\_alternative\_names\_order](#input\_subject\_alternative\_names\_order) | Order to list the subject alternative names in the ACM cert. Workaround for https://github.com/terraform-providers/terraform-provider-aws/issues/8531 | `list(string)` | `null` | no |
70+
| <a name="input_validation_record_ttl"></a> [validation\_record\_ttl](#input\_validation\_record\_ttl) | n/a | `string` | `60` | no |
5971

6072
## Outputs
6173

6274
| Name | Description |
6375
|------|-------------|
64-
| arn | n/a |
65-
| id | n/a |
66-
76+
| <a name="output_arn"></a> [arn](#output\_arn) | n/a |
77+
| <a name="output_id"></a> [id](#output\_id) | n/a |
6778
<!-- END -->

‎aws-aurora-mysql/README.md

+45-36
Original file line numberDiff line numberDiff line change
@@ -35,53 +35,62 @@ module "db" {
3535

3636
| Name | Version |
3737
|------|---------|
38-
| aws | >= 2.44.0, < 3.0.0 |
38+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 2.44.0, < 3.0.0 |
3939

4040
## Providers
4141

42-
No provider.
42+
No providers.
43+
44+
## Modules
45+
46+
| Name | Source | Version |
47+
|------|--------|---------|
48+
| <a name="module_aurora"></a> [aurora](#module\_aurora) | ../aws-aurora | |
49+
50+
## Resources
51+
52+
No resources.
4353

4454
## Inputs
4555

4656
| Name | Description | Type | Default | Required |
4757
|------|-------------|------|---------|:--------:|
48-
| apply\_immediately | If false changes will not be applied until next maintenance window. | `string` | `false` | no |
49-
| auto\_minor\_version\_upgrade | Set the databases to automatically upgrade minor versions. | `bool` | `true` | no |
50-
| backtrack\_window | Turns on Backgrack for this many seconds. [Doc](https://aws.amazon.com/blogs/aws/amazon-aurora-backtrack-turn-back-time/) | `string` | `0` | no |
51-
| ca\_cert\_identifier | Identifier for the certificate authority. rds-ca-2019 is the latest available version. | `string` | `"rds-ca-2019"` | no |
52-
| database\_name | The name of the database to be created in the cluster. | `string` | n/a | yes |
53-
| database\_password | Password for user that will be created. | `string` | n/a | yes |
54-
| database\_subnet\_group | The name of an existing database subnet group to use. | `string` | n/a | yes |
55-
| database\_username | Default user to be created. | `string` | n/a | yes |
56-
| db\_deletion\_protection | n/a | `string` | `false` | no |
57-
| db\_parameters | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Instance) | `list(any)` | <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 |
58-
| engine\_version | The version of the engine to be used for aurora-mysql. | `string` | `"5.7"` | no |
59-
| env | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
60-
| iam\_database\_authentication\_enabled | n/a | `string` | `false` | no |
61-
| ingress\_cidr\_blocks | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no |
62-
| ingress\_security\_groups | A list of security groups that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no |
63-
| instance\_class | See valid instance types [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Performance.html) | `string` | `"db.t2.small"` | no |
64-
| instance\_count | Number of instances to create in this cluster. | `string` | `1` | no |
65-
| kms\_key\_id | If provided, storage will be encrypted with this key, otherwise an AWS-managed key is used. (Encryption is always on). | `string` | `""` | no |
66-
| owner | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
67-
| params\_engine\_version | The engine version to be appended to the parameter group family. | `string` | `"5.7"` | no |
68-
| performance\_insights\_enabled | n/a | `string` | `false` | no |
69-
| project | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | `string` | n/a | yes |
70-
| publicly\_accessible | Avoid doing this - it gives access to the open internet. | `string` | `false` | no |
71-
| 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(any)` | <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 |
72-
| service | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
73-
| skip\_final\_snapshot | When you destroy a database RDS will, by default, take snapshot. Set this to skip that step. | `string` | `false` | no |
74-
| vpc\_id | The id of the existing VPC in which this cluster should be created. | `string` | n/a | yes |
58+
| <a name="input_apply_immediately"></a> [apply\_immediately](#input\_apply\_immediately) | If false changes will not be applied until next maintenance window. | `string` | `false` | no |
59+
| <a name="input_auto_minor_version_upgrade"></a> [auto\_minor\_version\_upgrade](#input\_auto\_minor\_version\_upgrade) | Set the databases to automatically upgrade minor versions. | `bool` | `true` | no |
60+
| <a name="input_backtrack_window"></a> [backtrack\_window](#input\_backtrack\_window) | Turns on Backgrack for this many seconds. [Doc](https://aws.amazon.com/blogs/aws/amazon-aurora-backtrack-turn-back-time/) | `string` | `0` | no |
61+
| <a name="input_ca_cert_identifier"></a> [ca\_cert\_identifier](#input\_ca\_cert\_identifier) | Identifier for the certificate authority. rds-ca-2019 is the latest available version. | `string` | `"rds-ca-2019"` | no |
62+
| <a name="input_database_name"></a> [database\_name](#input\_database\_name) | The name of the database to be created in the cluster. | `string` | n/a | yes |
63+
| <a name="input_database_password"></a> [database\_password](#input\_database\_password) | Password for user that will be created. | `string` | n/a | yes |
64+
| <a name="input_database_subnet_group"></a> [database\_subnet\_group](#input\_database\_subnet\_group) | The name of an existing database subnet group to use. | `string` | n/a | yes |
65+
| <a name="input_database_username"></a> [database\_username](#input\_database\_username) | Default user to be created. | `string` | n/a | yes |
66+
| <a name="input_db_deletion_protection"></a> [db\_deletion\_protection](#input\_db\_deletion\_protection) | n/a | `string` | `false` | no |
67+
| <a name="input_db_parameters"></a> [db\_parameters](#input\_db\_parameters) | Instance params you can set. [Doc](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Reference.html#AuroraMySQL.Reference.Parameters.Instance) | `list(any)` | <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 |
68+
| <a name="input_engine_version"></a> [engine\_version](#input\_engine\_version) | The version of the engine to be used for aurora-mysql. | `string` | `"5.7"` | no |
69+
| <a name="input_env"></a> [env](#input\_env) | Env for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
70+
| <a name="input_iam_database_authentication_enabled"></a> [iam\_database\_authentication\_enabled](#input\_iam\_database\_authentication\_enabled) | n/a | `string` | `false` | no |
71+
| <a name="input_ingress_cidr_blocks"></a> [ingress\_cidr\_blocks](#input\_ingress\_cidr\_blocks) | A list of CIDR blocks that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no |
72+
| <a name="input_ingress_security_groups"></a> [ingress\_security\_groups](#input\_ingress\_security\_groups) | A list of security groups that should be allowed to communicate with this Aurora cluster. | `list(string)` | `[]` | no |
73+
| <a name="input_instance_class"></a> [instance\_class](#input\_instance\_class) | See valid instance types [here](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Performance.html) | `string` | `"db.t2.small"` | no |
74+
| <a name="input_instance_count"></a> [instance\_count](#input\_instance\_count) | Number of instances to create in this cluster. | `string` | `1` | no |
75+
| <a name="input_kms_key_id"></a> [kms\_key\_id](#input\_kms\_key\_id) | If provided, storage will be encrypted with this key, otherwise an AWS-managed key is used. (Encryption is always on). | `string` | `""` | no |
76+
| <a name="input_owner"></a> [owner](#input\_owner) | Owner for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
77+
| <a name="input_params_engine_version"></a> [params\_engine\_version](#input\_params\_engine\_version) | The engine version to be appended to the parameter group family. | `string` | `"5.7"` | no |
78+
| <a name="input_performance_insights_enabled"></a> [performance\_insights\_enabled](#input\_performance\_insights\_enabled) | n/a | `string` | `false` | no |
79+
| <a name="input_project"></a> [project](#input\_project) | Project for tagging and naming. See [doc](../README.md#consistent-tagging) | `string` | n/a | yes |
80+
| <a name="input_publicly_accessible"></a> [publicly\_accessible](#input\_publicly\_accessible) | Avoid doing this - it gives access to the open internet. | `string` | `false` | no |
81+
| <a name="input_rds_cluster_parameters"></a> [rds\_cluster\_parameters](#input\_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(any)` | <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 |
82+
| <a name="input_service"></a> [service](#input\_service) | Service for tagging and naming. See [doc](../README.md#consistent-tagging). | `string` | n/a | yes |
83+
| <a name="input_skip_final_snapshot"></a> [skip\_final\_snapshot](#input\_skip\_final\_snapshot) | When you destroy a database RDS will, by default, take snapshot. Set this to skip that step. | `string` | `false` | no |
84+
| <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The id of the existing VPC in which this cluster should be created. | `string` | n/a | yes |
7585

7686
## Outputs
7787

7888
| Name | Description |
7989
|------|-------------|
80-
| database\_name | n/a |
81-
| db\_parameter\_group\_name | n/a |
82-
| endpoint | n/a |
83-
| engine | n/a |
84-
| rds\_cluster\_id | n/a |
85-
| reader\_endpoint | n/a |
86-
90+
| <a name="output_database_name"></a> [database\_name](#output\_database\_name) | n/a |
91+
| <a name="output_db_parameter_group_name"></a> [db\_parameter\_group\_name](#output\_db\_parameter\_group\_name) | n/a |
92+
| <a name="output_endpoint"></a> [endpoint](#output\_endpoint) | n/a |
93+
| <a name="output_engine"></a> [engine](#output\_engine) | n/a |
94+
| <a name="output_rds_cluster_id"></a> [rds\_cluster\_id](#output\_rds\_cluster\_id) | n/a |
95+
| <a name="output_reader_endpoint"></a> [reader\_endpoint](#output\_reader\_endpoint) | n/a |
8796
<!-- END -->

0 commit comments

Comments
 (0)