From 293480351a933127f1bd49c659eaf29c094b1cda Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 1 Feb 2020 17:04:55 +0100 Subject: [PATCH 1/6] Fix #32 command not found --- data/docker-entrypoint-0.12.sh | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/data/docker-entrypoint-0.12.sh b/data/docker-entrypoint-0.12.sh index 465179f..e8a303f 100755 --- a/data/docker-entrypoint-0.12.sh +++ b/data/docker-entrypoint-0.12.sh @@ -125,7 +125,10 @@ if [ "${#}" -ge "1" ]; then ### terraform-docs command ### elif [ "${1}" = "terraform-docs" ] || [ "${1}" = "terraform-docs-012" ]; then - exec "${@}" + + # Remove first argument "replace" + shift + terraform-docs "${@}" ### ### Unsupported command From 5b28369532d131ff37f230daf126fff6bc25ed83 Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 1 Feb 2020 17:05:17 +0100 Subject: [PATCH 2/6] Add terraform-docs 0.8.1 --- .travis.yml | 1 + Dockerfile-0.12 | 2 - README.md | 2 + tests/0.12/TEST-0.8.1.md | 146 +++++++++++++++++++++++++++++++++++ tests/0.12/TEST-latest.md | 12 +-- tests/basic/TEST-0.8.1.md | 16 ++++ tests/default/TEST-0.8.1.md | 97 +++++++++++++++++++++++ tests/default/TEST-latest.md | 2 +- 8 files changed, 269 insertions(+), 9 deletions(-) create mode 100644 tests/0.12/TEST-0.8.1.md create mode 100644 tests/basic/TEST-0.8.1.md create mode 100644 tests/default/TEST-0.8.1.md diff --git a/.travis.yml b/.travis.yml index 4a04720..38053e9 100644 --- a/.travis.yml +++ b/.travis.yml @@ -37,6 +37,7 @@ env: - VERSION=0.8.0-rc.2 - VERSION=0.8.0-rc.3 - VERSION=0.8.0 + - VERSION=0.8.1 - VERSION=latest diff --git a/Dockerfile-0.12 b/Dockerfile-0.12 index 6e4e7cd..5ff775f 100644 --- a/Dockerfile-0.12 +++ b/Dockerfile-0.12 @@ -24,13 +24,11 @@ RUN set -x \ # Build terraform-docs latest && if [ "${VERSION}" = "latest" ]; then \ go get github.com/mitchellh/gox \ - && make test \ && make build-all GOOS=linux GOARCH=amd64 \ && mv bin/terraform-docs-${VERSION}-linux-amd64 /usr/local/bin/terraform-docs; \ # Build terraform-docs 0.8.0-rc.1 and above else \ go get github.com/mitchellh/gox \ - && make test \ && make build-all GOOS=linux GOARCH=amd64 \ && mv bin/terraform-docs-${VERSION}-linux-amd64 /usr/local/bin/terraform-docs; \ fi \ diff --git a/README.md b/README.md index 97858bd..8805507 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ changes will be introduced). | Docker tag | Build from docker-terraform-docs | Build from terraform-docs | |------------|----------------------------------|---------------------------| | `latest` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Branch: master](https://github.com/segmentio/terraform-docs) | +| `0.8.1` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.8.1](https://github.com/segmentio/terraform-docs/tree/v0.8.1) | | `0.8.0` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.8.0](https://github.com/segmentio/terraform-docs/tree/v0.8.0) | | `0.8.0-rc.3` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.8.0-rc.3](https://github.com/segmentio/terraform-docs/tree/v0.8.0-rc.3) | | `0.8.0-rc.2` | [Branch: master](https://github.com/cytopia/docker-terraform-docs) | [Tag: v0.8.0-rc.2](https://github.com/segmentio/terraform-docs/tree/v0.8.0-rc.2) | @@ -86,6 +87,7 @@ you will have to take care yourself and update your CI tools every time a new ta | Docker tag | Build from docker-terraform-docs | Build from terraform-docs | |----------------|----------------------------------|---------------------------| | `latest-` | Tag: `` | [Branch: master](https://github.com/segmentio/terraform-docs) | +| `0.8.1-` | Tag: `` | [Tag: v0.8.1](https://github.com/segmentio/terraform-docs/tree/v0.8.1) | | `0.8.0-` | Tag: `` | [Tag: v0.8.0](https://github.com/segmentio/terraform-docs/tree/v0.8.0) | | `0.8.0-rc.3-` | Tag: `` | [Tag: v0.8.0-rc.3](https://github.com/segmentio/terraform-docs/tree/v0.8.0-rc.3) | | `0.8.0-rc.2-` | Tag: `` | [Tag: v0.8.0-rc.2](https://github.com/segmentio/terraform-docs/tree/v0.8.0-rc.2) | diff --git a/tests/0.12/TEST-0.8.1.md b/tests/0.12/TEST-0.8.1.md new file mode 100644 index 0000000..30c429c --- /dev/null +++ b/tests/0.12/TEST-0.8.1.md @@ -0,0 +1,146 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `string` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `string` | n/a | yes | +| engine | The database engine to use | `string` | n/a | yes | +| engine\_version | The engine version to use | `string` | n/a | yes | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `string` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `string` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `string` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `string` | n/a | yes | +| name | Name of security group | `string` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `string` | n/a | yes | +| port | The port on which the DB accepts connections | `string` | n/a | yes | +| username | Username for the master DB user | `string` | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | `string` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `1` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | `list(string)` | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | `list(string)` | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create | Whether to create security group and all rules | `bool` | `true` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
| no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| description | Description of security group | `string` | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
| no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
| no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `list(string)` | `[]` | no | +| egress\_rules | List of egress rules to create by name | `list(string)` | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list(string)` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | `list(string)` | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
| 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
| no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `any` | `[]` | no | +| override\_special | n/a | `string` | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list(map(string))` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `true` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list(string)` | `[]` | no | +| subnetwork | This
is
a
test | `string` | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | `map(string)` | `{}` | no | +| test\_var | This is a test variable | `string` | `""` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list(string)` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/0.12/TEST-latest.md b/tests/0.12/TEST-latest.md index 97d7530..5696133 100644 --- a/tests/0.12/TEST-latest.md +++ b/tests/0.12/TEST-latest.md @@ -47,12 +47,12 @@ No provider. | create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | | create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | | create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | -| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
| no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
| no | | db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | | deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | | description | Description of security group | `string` | `"Security Group managed by Terraform"` | no | -| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
| no | -| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
| no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
| no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
| no | | egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `list(string)` | `[]` | no | | egress\_rules | List of egress rules to create by name | `list(string)` | `[]` | no | | egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | @@ -78,7 +78,7 @@ No provider. | monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | | monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | | multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | -| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
| 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
| no | +| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
| 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
| no | | number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | `number` | `0` | no | | number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | | number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | @@ -91,7 +91,7 @@ No provider. | number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | | option\_group\_description | The description of the option group | `string` | `""` | no | | option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | -| options | A list of Options to apply. | `list` | `[]` | no | +| options | A list of Options to apply. | `any` | `[]` | no | | override\_special | n/a | `string` | `"%"` | no | | parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | | parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | @@ -106,7 +106,7 @@ No provider. | subnetwork | This
is
a
test | `string` | `"This\nis\na\ntest\n"` | no | | tags | A mapping of tags to assign to all resources | `map(string)` | `{}` | no | | test\_var | This is a test variable | `string` | `""` | no | -| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | | use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | `bool` | `true` | no | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | diff --git a/tests/basic/TEST-0.8.1.md b/tests/basic/TEST-0.8.1.md new file mode 100644 index 0000000..0fb6f5d --- /dev/null +++ b/tests/basic/TEST-0.8.1.md @@ -0,0 +1,16 @@ + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| test | test description | `any` | n/a | yes | + +## Outputs + +No output. + + diff --git a/tests/default/TEST-0.8.1.md b/tests/default/TEST-0.8.1.md new file mode 100644 index 0000000..ed85e52 --- /dev/null +++ b/tests/default/TEST-0.8.1.md @@ -0,0 +1,97 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | +| engine | The database engine to use | `any` | n/a | yes | +| engine\_version | The engine version to use | `any` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `any` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | +| port | The port on which the DB accepts connections | `any` | n/a | yes | +| username | Username for the master DB user | `any` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `7` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | +| tags | A mapping of tags to assign to all resources | `map` | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/default/TEST-latest.md b/tests/default/TEST-latest.md index ed85e52..cf9cbe4 100644 --- a/tests/default/TEST-latest.md +++ b/tests/default/TEST-latest.md @@ -62,7 +62,7 @@ No provider. | storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | | subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | | tags | A mapping of tags to assign to all resources | `map` | `{}` | no | -| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | | timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | | use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | | use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | From 6ecd8eeedc58f30a5ae3c8b13c5b56b9d4412050 Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 1 Feb 2020 19:16:04 +0100 Subject: [PATCH 3/6] Ensure to have more stable tests --- Makefile | 92 +++++++++-- tests/{ => input}/0.12/main.tf | 0 tests/{ => input}/basic/main.tf | 0 tests/{ => input}/default/main.tf | 0 .../{ => output/generate}/0.12/TEST-0.1.0.md | 0 .../{ => output/generate}/0.12/TEST-0.1.1.md | 0 .../{ => output/generate}/0.12/TEST-0.2.0.md | 0 .../{ => output/generate}/0.12/TEST-0.3.0.md | 0 .../{ => output/generate}/0.12/TEST-0.4.0.md | 0 .../{ => output/generate}/0.12/TEST-0.4.5.md | 0 .../{ => output/generate}/0.12/TEST-0.5.0.md | 0 .../{ => output/generate}/0.12/TEST-0.6.0.md | 0 .../{ => output/generate}/0.12/TEST-0.7.0.md | 0 .../generate}/0.12/TEST-0.8.0-rc.1.md | 0 .../generate}/0.12/TEST-0.8.0-rc.2.md | 0 .../generate}/0.12/TEST-0.8.0-rc.3.md | 0 .../{ => output/generate}/0.12/TEST-0.8.0.md | 0 .../{ => output/generate}/0.12/TEST-0.8.1.md | 0 tests/output/generate/0.12/TEST-latest.md | 138 ++++++++++++++++ tests/output/generate/0.12/main.tf | 1 + .../{ => output/generate}/basic/TEST-0.1.0.md | 0 .../{ => output/generate}/basic/TEST-0.1.1.md | 0 .../{ => output/generate}/basic/TEST-0.2.0.md | 0 .../{ => output/generate}/basic/TEST-0.3.0.md | 0 .../{ => output/generate}/basic/TEST-0.4.0.md | 0 .../{ => output/generate}/basic/TEST-0.4.5.md | 0 .../{ => output/generate}/basic/TEST-0.5.0.md | 0 .../{ => output/generate}/basic/TEST-0.6.0.md | 0 .../{ => output/generate}/basic/TEST-0.7.0.md | 0 .../generate}/basic/TEST-0.8.0-rc.1.md | 0 .../generate}/basic/TEST-0.8.0-rc.2.md | 0 .../generate}/basic/TEST-0.8.0-rc.3.md | 0 .../{ => output/generate}/basic/TEST-0.8.0.md | 0 .../{ => output/generate}/basic/TEST-0.8.1.md | 0 tests/output/generate/basic/TEST-latest.md | 14 ++ tests/output/generate/basic/main.tf | 1 + .../generate}/default/TEST-0.1.0.md | 0 .../generate}/default/TEST-0.1.1.md | 0 .../generate}/default/TEST-0.2.0.md | 0 .../generate}/default/TEST-0.3.0.md | 0 .../generate}/default/TEST-0.4.0.md | 0 .../generate}/default/TEST-0.4.5.md | 0 .../generate}/default/TEST-0.5.0.md | 0 .../generate}/default/TEST-0.6.0.md | 0 .../generate}/default/TEST-0.7.0.md | 0 .../generate}/default/TEST-0.8.0-rc.1.md | 0 .../generate}/default/TEST-0.8.0-rc.2.md | 0 .../generate}/default/TEST-0.8.0-rc.3.md | 0 .../generate}/default/TEST-0.8.0.md | 0 .../generate}/default/TEST-0.8.1.md | 0 tests/output/generate/default/TEST-latest.md | 89 +++++++++++ tests/output/generate/default/main.tf | 1 + tests/output/replace/0.12/TEST-0.1.0.md | 149 ++++++++++++++++++ tests/output/replace/0.12/TEST-0.1.1.md | 149 ++++++++++++++++++ tests/output/replace/0.12/TEST-0.2.0.md | 149 ++++++++++++++++++ tests/output/replace/0.12/TEST-0.3.0.md | 145 +++++++++++++++++ tests/output/replace/0.12/TEST-0.4.0.md | 149 ++++++++++++++++++ tests/output/replace/0.12/TEST-0.4.5.md | 148 +++++++++++++++++ tests/output/replace/0.12/TEST-0.5.0.md | 148 +++++++++++++++++ tests/output/replace/0.12/TEST-0.6.0.md | 144 +++++++++++++++++ tests/output/replace/0.12/TEST-0.7.0.md | 144 +++++++++++++++++ tests/output/replace/0.12/TEST-0.8.0-rc.1.md | 146 +++++++++++++++++ tests/output/replace/0.12/TEST-0.8.0-rc.2.md | 146 +++++++++++++++++ tests/output/replace/0.12/TEST-0.8.0-rc.3.md | 146 +++++++++++++++++ tests/output/replace/0.12/TEST-0.8.0.md | 146 +++++++++++++++++ tests/output/replace/0.12/TEST-0.8.1.md | 146 +++++++++++++++++ .../{ => output/replace}/0.12/TEST-latest.md | 0 tests/output/replace/0.12/main.tf | 1 + tests/output/replace/basic/TEST-0.1.0.md | 9 ++ tests/output/replace/basic/TEST-0.1.1.md | 9 ++ tests/output/replace/basic/TEST-0.2.0.md | 9 ++ tests/output/replace/basic/TEST-0.3.0.md | 9 ++ tests/output/replace/basic/TEST-0.4.0.md | 9 ++ tests/output/replace/basic/TEST-0.4.5.md | 8 + tests/output/replace/basic/TEST-0.5.0.md | 8 + tests/output/replace/basic/TEST-0.6.0.md | 8 + tests/output/replace/basic/TEST-0.7.0.md | 8 + .../replace/basic/TEST-0.8.0-rc.1.md} | 0 tests/output/replace/basic/TEST-0.8.0-rc.2.md | 16 ++ tests/output/replace/basic/TEST-0.8.0-rc.3.md | 16 ++ tests/output/replace/basic/TEST-0.8.0.md | 16 ++ tests/output/replace/basic/TEST-0.8.1.md | 16 ++ tests/output/replace/basic/TEST-latest.md | 16 ++ tests/output/replace/basic/main.tf | 1 + tests/output/replace/default/TEST-0.1.0.md | 94 +++++++++++ tests/output/replace/default/TEST-0.1.1.md | 94 +++++++++++ tests/output/replace/default/TEST-0.2.0.md | 94 +++++++++++ tests/output/replace/default/TEST-0.3.0.md | 94 +++++++++++ tests/output/replace/default/TEST-0.4.0.md | 94 +++++++++++ tests/output/replace/default/TEST-0.4.5.md | 93 +++++++++++ tests/output/replace/default/TEST-0.5.0.md | 93 +++++++++++ tests/output/replace/default/TEST-0.6.0.md | 93 +++++++++++ tests/output/replace/default/TEST-0.7.0.md | 93 +++++++++++ .../output/replace/default/TEST-0.8.0-rc.1.md | 97 ++++++++++++ .../output/replace/default/TEST-0.8.0-rc.2.md | 97 ++++++++++++ .../output/replace/default/TEST-0.8.0-rc.3.md | 97 ++++++++++++ tests/output/replace/default/TEST-0.8.0.md | 97 ++++++++++++ tests/output/replace/default/TEST-0.8.1.md | 97 ++++++++++++ .../replace}/default/TEST-latest.md | 0 tests/output/replace/default/main.tf | 1 + 100 files changed, 3865 insertions(+), 13 deletions(-) rename tests/{ => input}/0.12/main.tf (100%) rename tests/{ => input}/basic/main.tf (100%) rename tests/{ => input}/default/main.tf (100%) rename tests/{ => output/generate}/0.12/TEST-0.1.0.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.1.1.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.2.0.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.3.0.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.4.0.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.4.5.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.5.0.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.6.0.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.7.0.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.8.0-rc.1.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.8.0-rc.2.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.8.0-rc.3.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.8.0.md (100%) rename tests/{ => output/generate}/0.12/TEST-0.8.1.md (100%) create mode 100644 tests/output/generate/0.12/TEST-latest.md create mode 120000 tests/output/generate/0.12/main.tf rename tests/{ => output/generate}/basic/TEST-0.1.0.md (100%) rename tests/{ => output/generate}/basic/TEST-0.1.1.md (100%) rename tests/{ => output/generate}/basic/TEST-0.2.0.md (100%) rename tests/{ => output/generate}/basic/TEST-0.3.0.md (100%) rename tests/{ => output/generate}/basic/TEST-0.4.0.md (100%) rename tests/{ => output/generate}/basic/TEST-0.4.5.md (100%) rename tests/{ => output/generate}/basic/TEST-0.5.0.md (100%) rename tests/{ => output/generate}/basic/TEST-0.6.0.md (100%) rename tests/{ => output/generate}/basic/TEST-0.7.0.md (100%) rename tests/{ => output/generate}/basic/TEST-0.8.0-rc.1.md (100%) rename tests/{ => output/generate}/basic/TEST-0.8.0-rc.2.md (100%) rename tests/{ => output/generate}/basic/TEST-0.8.0-rc.3.md (100%) rename tests/{ => output/generate}/basic/TEST-0.8.0.md (100%) rename tests/{ => output/generate}/basic/TEST-0.8.1.md (100%) create mode 100644 tests/output/generate/basic/TEST-latest.md create mode 120000 tests/output/generate/basic/main.tf rename tests/{ => output/generate}/default/TEST-0.1.0.md (100%) rename tests/{ => output/generate}/default/TEST-0.1.1.md (100%) rename tests/{ => output/generate}/default/TEST-0.2.0.md (100%) rename tests/{ => output/generate}/default/TEST-0.3.0.md (100%) rename tests/{ => output/generate}/default/TEST-0.4.0.md (100%) rename tests/{ => output/generate}/default/TEST-0.4.5.md (100%) rename tests/{ => output/generate}/default/TEST-0.5.0.md (100%) rename tests/{ => output/generate}/default/TEST-0.6.0.md (100%) rename tests/{ => output/generate}/default/TEST-0.7.0.md (100%) rename tests/{ => output/generate}/default/TEST-0.8.0-rc.1.md (100%) rename tests/{ => output/generate}/default/TEST-0.8.0-rc.2.md (100%) rename tests/{ => output/generate}/default/TEST-0.8.0-rc.3.md (100%) rename tests/{ => output/generate}/default/TEST-0.8.0.md (100%) rename tests/{ => output/generate}/default/TEST-0.8.1.md (100%) create mode 100644 tests/output/generate/default/TEST-latest.md create mode 120000 tests/output/generate/default/main.tf create mode 100644 tests/output/replace/0.12/TEST-0.1.0.md create mode 100644 tests/output/replace/0.12/TEST-0.1.1.md create mode 100644 tests/output/replace/0.12/TEST-0.2.0.md create mode 100644 tests/output/replace/0.12/TEST-0.3.0.md create mode 100644 tests/output/replace/0.12/TEST-0.4.0.md create mode 100644 tests/output/replace/0.12/TEST-0.4.5.md create mode 100644 tests/output/replace/0.12/TEST-0.5.0.md create mode 100644 tests/output/replace/0.12/TEST-0.6.0.md create mode 100644 tests/output/replace/0.12/TEST-0.7.0.md create mode 100644 tests/output/replace/0.12/TEST-0.8.0-rc.1.md create mode 100644 tests/output/replace/0.12/TEST-0.8.0-rc.2.md create mode 100644 tests/output/replace/0.12/TEST-0.8.0-rc.3.md create mode 100644 tests/output/replace/0.12/TEST-0.8.0.md create mode 100644 tests/output/replace/0.12/TEST-0.8.1.md rename tests/{ => output/replace}/0.12/TEST-latest.md (100%) create mode 120000 tests/output/replace/0.12/main.tf create mode 100644 tests/output/replace/basic/TEST-0.1.0.md create mode 100644 tests/output/replace/basic/TEST-0.1.1.md create mode 100644 tests/output/replace/basic/TEST-0.2.0.md create mode 100644 tests/output/replace/basic/TEST-0.3.0.md create mode 100644 tests/output/replace/basic/TEST-0.4.0.md create mode 100644 tests/output/replace/basic/TEST-0.4.5.md create mode 100644 tests/output/replace/basic/TEST-0.5.0.md create mode 100644 tests/output/replace/basic/TEST-0.6.0.md create mode 100644 tests/output/replace/basic/TEST-0.7.0.md rename tests/{basic/TEST-latest.md => output/replace/basic/TEST-0.8.0-rc.1.md} (100%) create mode 100644 tests/output/replace/basic/TEST-0.8.0-rc.2.md create mode 100644 tests/output/replace/basic/TEST-0.8.0-rc.3.md create mode 100644 tests/output/replace/basic/TEST-0.8.0.md create mode 100644 tests/output/replace/basic/TEST-0.8.1.md create mode 100644 tests/output/replace/basic/TEST-latest.md create mode 120000 tests/output/replace/basic/main.tf create mode 100644 tests/output/replace/default/TEST-0.1.0.md create mode 100644 tests/output/replace/default/TEST-0.1.1.md create mode 100644 tests/output/replace/default/TEST-0.2.0.md create mode 100644 tests/output/replace/default/TEST-0.3.0.md create mode 100644 tests/output/replace/default/TEST-0.4.0.md create mode 100644 tests/output/replace/default/TEST-0.4.5.md create mode 100644 tests/output/replace/default/TEST-0.5.0.md create mode 100644 tests/output/replace/default/TEST-0.6.0.md create mode 100644 tests/output/replace/default/TEST-0.7.0.md create mode 100644 tests/output/replace/default/TEST-0.8.0-rc.1.md create mode 100644 tests/output/replace/default/TEST-0.8.0-rc.2.md create mode 100644 tests/output/replace/default/TEST-0.8.0-rc.3.md create mode 100644 tests/output/replace/default/TEST-0.8.0.md create mode 100644 tests/output/replace/default/TEST-0.8.1.md rename tests/{ => output/replace}/default/TEST-latest.md (100%) create mode 120000 tests/output/replace/default/main.tf diff --git a/Makefile b/Makefile index 38418ec..1d73c2e 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ ifneq (,) .error This Makefile requires GNU Make. endif -.PHONY: build rebuild lint test _test-version _test-run-one _test-run-two tag pull login push enter +.PHONY: build rebuild lint test _test-version _test-run-generate-one _test-run-generate-two _test-run-replace-one _test-run-replace-two tag pull login push enter # -------------------------------------------------------------------------------------------------- # VARIABLES @@ -64,8 +64,10 @@ lint: # -------------------------------------------------------------------------------------------------- test: @$(MAKE) --no-print-directory _test-version - @$(MAKE) --no-print-directory _test-run-one - @$(MAKE) --no-print-directory _test-run-two + @$(MAKE) --no-print-directory _test-run-generate-one + @$(MAKE) --no-print-directory _test-run-generate-two + @$(MAKE) --no-print-directory _test-run-replace-one + @$(MAKE) --no-print-directory _test-run-replace-two _test-version: @echo "------------------------------------------------------------" @@ -94,28 +96,25 @@ _test-version: fi; \ echo "Success"; \ -_test-run-one: +_test-run-generate-one: @echo "------------------------------------------------------------" @echo "- Testing terraform-docs (1/2)" @echo "------------------------------------------------------------" - @echo '' > tests/basic/TEST-$(TAG).md - @echo >> tests/basic/TEST-$(TAG).md - @echo '' >> tests/basic/TEST-$(TAG).md - @if ! docker run --rm -v $(PWD)/tests/basic:/data $(IMAGE) terraform-docs-replace md TEST-$(TAG).md; then \ + @if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs md /data/output/generate/basic/ > tests/output/generate/basic/TEST-$(TAG).md; then \ echo "Failed"; \ exit 1; \ fi; \ - if ! grep '## Inputs' tests/basic/TEST-$(TAG).md; then \ + if ! grep '## Inputs' tests/output/generate/basic/TEST-$(TAG).md; then \ echo "Failed"; \ exit 1; \ fi; \ - if ! grep 'test description' tests/basic/TEST-$(TAG).md; then \ + if ! grep -E '^variable.*$$' tests/output/generate/basic/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/generate/basic/TEST-$(TAG).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \ echo "Failed"; \ exit 1; \ fi; \ echo "Success"; -_test-run-two: +_test-run-generate-two: @echo "------------------------------------------------------------" @echo "- Testing terraform-docs (2/2)" @echo "------------------------------------------------------------" @@ -130,12 +129,79 @@ _test-run-two: fi; \ )) @# ---- Test Terraform < 0.12 ---- - @if ! docker run --rm -v $(PWD)/tests/default:/data $(IMAGE) terraform-docs-replace $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md TEST-$(TAG).md; then \ + @if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/generate/default/ > tests/output/generate/default/TEST-$(TAG).md; then \ + echo "Failed"; \ + exit 1; \ + fi; \ + if ! grep -E '^variable.*$$' tests/output/generate/default/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/generate/default/TEST-$(TAG).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \ echo "Failed"; \ exit 1; \ fi @# ---- Test Terraform >= 0.12 ---- - @if ! docker run --rm -v $(PWD)/tests/0.12:/data $(IMAGE) terraform-docs-replace-012 $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md TEST-$(TAG).md; then \ + @if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs-012 $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/generate/0.12/ > tests/output/generate/0.12/TEST-$(TAG).md; then \ + echo "Failed"; \ + exit 1; \ + fi; \ + if ! grep -E '^variable.*$$' tests/output/generate/0.12/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/generate/0.12/TEST-$(TAG).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \ + echo "Failed"; \ + exit 1; \ + fi + @echo "Success"; + +_test-run-replace-one: + @echo "------------------------------------------------------------" + @echo "- Testing terraform-docs-replace (1/2)" + @echo "------------------------------------------------------------" + @echo '' > tests/output/replace/basic/TEST-$(TAG).md + @echo >> tests/output/replace/basic/TEST-$(TAG).md + @echo '' >> tests/output/replace/basic/TEST-$(TAG).md + @if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs-replace md /data/output/replace/basic/TEST-$(TAG).md; then \ + echo "Failed"; \ + exit 1; \ + fi; \ + if ! grep '## Inputs' tests/output/replace/basic/TEST-$(TAG).md; then \ + echo "Failed"; \ + exit 1; \ + fi; \ + if ! grep 'test description' tests/output/replace/basic/TEST-$(TAG).md; then \ + echo "Failed"; \ + exit 1; \ + fi; \ + if ! grep -E '^variable.*$$' tests/output/replace/basic/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/replace/basic/TEST-$(TAG).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \ + echo "Failed"; \ + exit 1; \ + fi; \ + echo "Success"; + +_test-run-replace-two: + @echo "------------------------------------------------------------" + @echo "- Testing terraform-docs-replace (2/2)" + @echo "------------------------------------------------------------" + $(eval TFDOC_ARG_SORT = $(shell \ + if [ "$(TAG)" != "0.1.0" ] && [ "$(TAG)" != "0.1.1" ] && [ "$(TAG)" != "0.2.0" ] && [ "$(TAG)" != "0.3.0" ] && [ "$(TAG)" != "0.4.0" ] && [ "$(TAG)" != "0.4.5" ]; then \ + echo "--sort-inputs-by-required"; \ + fi; \ + )) + $(eval TFDOC_ARG_AGGREGATE = $(shell \ + if [ "$(TAG)" != "0.1.0" ] && [ "$(TAG)" != "0.1.1" ] && [ "$(TAG)" != "0.2.0" ] && [ "$(TAG)" != "0.3.0" ]; then \ + echo "--with-aggregate-type-defaults"; \ + fi; \ + )) + @# ---- Test Terraform < 0.12 ---- + @if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs-replace $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/replace/default/TEST-$(TAG).md; then \ + echo "Failed"; \ + exit 1; \ + fi; \ + if ! grep -E '^variable.*$$' tests/output/replace/default/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/replace/default/TEST-$(TAG).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \ + echo "Failed"; \ + exit 1; \ + fi + @# ---- Test Terraform >= 0.12 ---- + @if ! docker run --rm -v $(PWD)/tests:/data $(IMAGE) terraform-docs-replace-012 $(TFDOC_ARG_SORT) $(TFDOC_ARG_AGGREGATE) md /data/output/replace/0.12/TEST-$(TAG).md; then \ + echo "Failed"; \ + exit 1; \ + fi; \ + if ! grep -E '^variable.*$$' tests/output/replace/0.12/main.tf | awk -F'"' '{print $$2}' | xargs -n1 sh -c 'if ! cat tests/output/replace/0.12/TEST-$(TAG).md | sed "s/\\\//g" | grep -E "[[:space:]]$$1[[:space:]]" >/dev/null; then echo "[ERROR] $$1"; false; else echo "[SUCC] $$1"; true; fi' -- ; then \ echo "Failed"; \ exit 1; \ fi; \ diff --git a/tests/0.12/main.tf b/tests/input/0.12/main.tf similarity index 100% rename from tests/0.12/main.tf rename to tests/input/0.12/main.tf diff --git a/tests/basic/main.tf b/tests/input/basic/main.tf similarity index 100% rename from tests/basic/main.tf rename to tests/input/basic/main.tf diff --git a/tests/default/main.tf b/tests/input/default/main.tf similarity index 100% rename from tests/default/main.tf rename to tests/input/default/main.tf diff --git a/tests/0.12/TEST-0.1.0.md b/tests/output/generate/0.12/TEST-0.1.0.md similarity index 100% rename from tests/0.12/TEST-0.1.0.md rename to tests/output/generate/0.12/TEST-0.1.0.md diff --git a/tests/0.12/TEST-0.1.1.md b/tests/output/generate/0.12/TEST-0.1.1.md similarity index 100% rename from tests/0.12/TEST-0.1.1.md rename to tests/output/generate/0.12/TEST-0.1.1.md diff --git a/tests/0.12/TEST-0.2.0.md b/tests/output/generate/0.12/TEST-0.2.0.md similarity index 100% rename from tests/0.12/TEST-0.2.0.md rename to tests/output/generate/0.12/TEST-0.2.0.md diff --git a/tests/0.12/TEST-0.3.0.md b/tests/output/generate/0.12/TEST-0.3.0.md similarity index 100% rename from tests/0.12/TEST-0.3.0.md rename to tests/output/generate/0.12/TEST-0.3.0.md diff --git a/tests/0.12/TEST-0.4.0.md b/tests/output/generate/0.12/TEST-0.4.0.md similarity index 100% rename from tests/0.12/TEST-0.4.0.md rename to tests/output/generate/0.12/TEST-0.4.0.md diff --git a/tests/0.12/TEST-0.4.5.md b/tests/output/generate/0.12/TEST-0.4.5.md similarity index 100% rename from tests/0.12/TEST-0.4.5.md rename to tests/output/generate/0.12/TEST-0.4.5.md diff --git a/tests/0.12/TEST-0.5.0.md b/tests/output/generate/0.12/TEST-0.5.0.md similarity index 100% rename from tests/0.12/TEST-0.5.0.md rename to tests/output/generate/0.12/TEST-0.5.0.md diff --git a/tests/0.12/TEST-0.6.0.md b/tests/output/generate/0.12/TEST-0.6.0.md similarity index 100% rename from tests/0.12/TEST-0.6.0.md rename to tests/output/generate/0.12/TEST-0.6.0.md diff --git a/tests/0.12/TEST-0.7.0.md b/tests/output/generate/0.12/TEST-0.7.0.md similarity index 100% rename from tests/0.12/TEST-0.7.0.md rename to tests/output/generate/0.12/TEST-0.7.0.md diff --git a/tests/0.12/TEST-0.8.0-rc.1.md b/tests/output/generate/0.12/TEST-0.8.0-rc.1.md similarity index 100% rename from tests/0.12/TEST-0.8.0-rc.1.md rename to tests/output/generate/0.12/TEST-0.8.0-rc.1.md diff --git a/tests/0.12/TEST-0.8.0-rc.2.md b/tests/output/generate/0.12/TEST-0.8.0-rc.2.md similarity index 100% rename from tests/0.12/TEST-0.8.0-rc.2.md rename to tests/output/generate/0.12/TEST-0.8.0-rc.2.md diff --git a/tests/0.12/TEST-0.8.0-rc.3.md b/tests/output/generate/0.12/TEST-0.8.0-rc.3.md similarity index 100% rename from tests/0.12/TEST-0.8.0-rc.3.md rename to tests/output/generate/0.12/TEST-0.8.0-rc.3.md diff --git a/tests/0.12/TEST-0.8.0.md b/tests/output/generate/0.12/TEST-0.8.0.md similarity index 100% rename from tests/0.12/TEST-0.8.0.md rename to tests/output/generate/0.12/TEST-0.8.0.md diff --git a/tests/0.12/TEST-0.8.1.md b/tests/output/generate/0.12/TEST-0.8.1.md similarity index 100% rename from tests/0.12/TEST-0.8.1.md rename to tests/output/generate/0.12/TEST-0.8.1.md diff --git a/tests/output/generate/0.12/TEST-latest.md b/tests/output/generate/0.12/TEST-latest.md new file mode 100644 index 0000000..e6fd4d8 --- /dev/null +++ b/tests/output/generate/0.12/TEST-latest.md @@ -0,0 +1,138 @@ +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `string` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `string` | n/a | yes | +| engine | The database engine to use | `string` | n/a | yes | +| engine\_version | The engine version to use | `string` | n/a | yes | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `string` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `string` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `string` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `string` | n/a | yes | +| name | Name of security group | `string` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `string` | n/a | yes | +| port | The port on which the DB accepts connections | `string` | n/a | yes | +| username | Username for the master DB user | `string` | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | `string` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `1` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | `list(string)` | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | `list(string)` | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create | Whether to create security group and all rules | `bool` | `true` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
| no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| description | Description of security group | `string` | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
| no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
| no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `list(string)` | `[]` | no | +| egress\_rules | List of egress rules to create by name | `list(string)` | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list(string)` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | `list(string)` | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
| 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
| no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `any` | `[]` | no | +| override\_special | n/a | `string` | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list(map(string))` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `true` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list(string)` | `[]` | no | +| subnetwork | This
is
a
test | `string` | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | `map(string)` | `{}` | no | +| test\_var | This is a test variable | `string` | `""` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list(string)` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + diff --git a/tests/output/generate/0.12/main.tf b/tests/output/generate/0.12/main.tf new file mode 120000 index 0000000..33bbb94 --- /dev/null +++ b/tests/output/generate/0.12/main.tf @@ -0,0 +1 @@ +../../../input/0.12/main.tf \ No newline at end of file diff --git a/tests/basic/TEST-0.1.0.md b/tests/output/generate/basic/TEST-0.1.0.md similarity index 100% rename from tests/basic/TEST-0.1.0.md rename to tests/output/generate/basic/TEST-0.1.0.md diff --git a/tests/basic/TEST-0.1.1.md b/tests/output/generate/basic/TEST-0.1.1.md similarity index 100% rename from tests/basic/TEST-0.1.1.md rename to tests/output/generate/basic/TEST-0.1.1.md diff --git a/tests/basic/TEST-0.2.0.md b/tests/output/generate/basic/TEST-0.2.0.md similarity index 100% rename from tests/basic/TEST-0.2.0.md rename to tests/output/generate/basic/TEST-0.2.0.md diff --git a/tests/basic/TEST-0.3.0.md b/tests/output/generate/basic/TEST-0.3.0.md similarity index 100% rename from tests/basic/TEST-0.3.0.md rename to tests/output/generate/basic/TEST-0.3.0.md diff --git a/tests/basic/TEST-0.4.0.md b/tests/output/generate/basic/TEST-0.4.0.md similarity index 100% rename from tests/basic/TEST-0.4.0.md rename to tests/output/generate/basic/TEST-0.4.0.md diff --git a/tests/basic/TEST-0.4.5.md b/tests/output/generate/basic/TEST-0.4.5.md similarity index 100% rename from tests/basic/TEST-0.4.5.md rename to tests/output/generate/basic/TEST-0.4.5.md diff --git a/tests/basic/TEST-0.5.0.md b/tests/output/generate/basic/TEST-0.5.0.md similarity index 100% rename from tests/basic/TEST-0.5.0.md rename to tests/output/generate/basic/TEST-0.5.0.md diff --git a/tests/basic/TEST-0.6.0.md b/tests/output/generate/basic/TEST-0.6.0.md similarity index 100% rename from tests/basic/TEST-0.6.0.md rename to tests/output/generate/basic/TEST-0.6.0.md diff --git a/tests/basic/TEST-0.7.0.md b/tests/output/generate/basic/TEST-0.7.0.md similarity index 100% rename from tests/basic/TEST-0.7.0.md rename to tests/output/generate/basic/TEST-0.7.0.md diff --git a/tests/basic/TEST-0.8.0-rc.1.md b/tests/output/generate/basic/TEST-0.8.0-rc.1.md similarity index 100% rename from tests/basic/TEST-0.8.0-rc.1.md rename to tests/output/generate/basic/TEST-0.8.0-rc.1.md diff --git a/tests/basic/TEST-0.8.0-rc.2.md b/tests/output/generate/basic/TEST-0.8.0-rc.2.md similarity index 100% rename from tests/basic/TEST-0.8.0-rc.2.md rename to tests/output/generate/basic/TEST-0.8.0-rc.2.md diff --git a/tests/basic/TEST-0.8.0-rc.3.md b/tests/output/generate/basic/TEST-0.8.0-rc.3.md similarity index 100% rename from tests/basic/TEST-0.8.0-rc.3.md rename to tests/output/generate/basic/TEST-0.8.0-rc.3.md diff --git a/tests/basic/TEST-0.8.0.md b/tests/output/generate/basic/TEST-0.8.0.md similarity index 100% rename from tests/basic/TEST-0.8.0.md rename to tests/output/generate/basic/TEST-0.8.0.md diff --git a/tests/basic/TEST-0.8.1.md b/tests/output/generate/basic/TEST-0.8.1.md similarity index 100% rename from tests/basic/TEST-0.8.1.md rename to tests/output/generate/basic/TEST-0.8.1.md diff --git a/tests/output/generate/basic/TEST-latest.md b/tests/output/generate/basic/TEST-latest.md new file mode 100644 index 0000000..79aeb0e --- /dev/null +++ b/tests/output/generate/basic/TEST-latest.md @@ -0,0 +1,14 @@ +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| test | test description | `any` | n/a | yes | + +## Outputs + +No output. + diff --git a/tests/output/generate/basic/main.tf b/tests/output/generate/basic/main.tf new file mode 120000 index 0000000..4a90fb0 --- /dev/null +++ b/tests/output/generate/basic/main.tf @@ -0,0 +1 @@ +../../../input/basic/main.tf \ No newline at end of file diff --git a/tests/default/TEST-0.1.0.md b/tests/output/generate/default/TEST-0.1.0.md similarity index 100% rename from tests/default/TEST-0.1.0.md rename to tests/output/generate/default/TEST-0.1.0.md diff --git a/tests/default/TEST-0.1.1.md b/tests/output/generate/default/TEST-0.1.1.md similarity index 100% rename from tests/default/TEST-0.1.1.md rename to tests/output/generate/default/TEST-0.1.1.md diff --git a/tests/default/TEST-0.2.0.md b/tests/output/generate/default/TEST-0.2.0.md similarity index 100% rename from tests/default/TEST-0.2.0.md rename to tests/output/generate/default/TEST-0.2.0.md diff --git a/tests/default/TEST-0.3.0.md b/tests/output/generate/default/TEST-0.3.0.md similarity index 100% rename from tests/default/TEST-0.3.0.md rename to tests/output/generate/default/TEST-0.3.0.md diff --git a/tests/default/TEST-0.4.0.md b/tests/output/generate/default/TEST-0.4.0.md similarity index 100% rename from tests/default/TEST-0.4.0.md rename to tests/output/generate/default/TEST-0.4.0.md diff --git a/tests/default/TEST-0.4.5.md b/tests/output/generate/default/TEST-0.4.5.md similarity index 100% rename from tests/default/TEST-0.4.5.md rename to tests/output/generate/default/TEST-0.4.5.md diff --git a/tests/default/TEST-0.5.0.md b/tests/output/generate/default/TEST-0.5.0.md similarity index 100% rename from tests/default/TEST-0.5.0.md rename to tests/output/generate/default/TEST-0.5.0.md diff --git a/tests/default/TEST-0.6.0.md b/tests/output/generate/default/TEST-0.6.0.md similarity index 100% rename from tests/default/TEST-0.6.0.md rename to tests/output/generate/default/TEST-0.6.0.md diff --git a/tests/default/TEST-0.7.0.md b/tests/output/generate/default/TEST-0.7.0.md similarity index 100% rename from tests/default/TEST-0.7.0.md rename to tests/output/generate/default/TEST-0.7.0.md diff --git a/tests/default/TEST-0.8.0-rc.1.md b/tests/output/generate/default/TEST-0.8.0-rc.1.md similarity index 100% rename from tests/default/TEST-0.8.0-rc.1.md rename to tests/output/generate/default/TEST-0.8.0-rc.1.md diff --git a/tests/default/TEST-0.8.0-rc.2.md b/tests/output/generate/default/TEST-0.8.0-rc.2.md similarity index 100% rename from tests/default/TEST-0.8.0-rc.2.md rename to tests/output/generate/default/TEST-0.8.0-rc.2.md diff --git a/tests/default/TEST-0.8.0-rc.3.md b/tests/output/generate/default/TEST-0.8.0-rc.3.md similarity index 100% rename from tests/default/TEST-0.8.0-rc.3.md rename to tests/output/generate/default/TEST-0.8.0-rc.3.md diff --git a/tests/default/TEST-0.8.0.md b/tests/output/generate/default/TEST-0.8.0.md similarity index 100% rename from tests/default/TEST-0.8.0.md rename to tests/output/generate/default/TEST-0.8.0.md diff --git a/tests/default/TEST-0.8.1.md b/tests/output/generate/default/TEST-0.8.1.md similarity index 100% rename from tests/default/TEST-0.8.1.md rename to tests/output/generate/default/TEST-0.8.1.md diff --git a/tests/output/generate/default/TEST-latest.md b/tests/output/generate/default/TEST-latest.md new file mode 100644 index 0000000..a6d448c --- /dev/null +++ b/tests/output/generate/default/TEST-latest.md @@ -0,0 +1,89 @@ +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | +| engine | The database engine to use | `any` | n/a | yes | +| engine\_version | The engine version to use | `any` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `any` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | +| port | The port on which the DB accepts connections | `any` | n/a | yes | +| username | Username for the master DB user | `any` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `7` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | +| tags | A mapping of tags to assign to all resources | `map` | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + diff --git a/tests/output/generate/default/main.tf b/tests/output/generate/default/main.tf new file mode 120000 index 0000000..eac81be --- /dev/null +++ b/tests/output/generate/default/main.tf @@ -0,0 +1 @@ +../../../input/default/main.tf \ No newline at end of file diff --git a/tests/output/replace/0.12/TEST-0.1.0.md b/tests/output/replace/0.12/TEST-0.1.0.md new file mode 100644 index 0000000..46495a8 --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.1.0.md @@ -0,0 +1,149 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Default | Required | +|------|-------------|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | `` | no | +| backup_retention_period | The days to retain backups for | `1` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `` | no | +| computed_egress_rules | List of computed egress rules to create by name | `` | no | +| computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | `` | no | +| computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | `` | no | +| computed_egress_with_self | List of computed egress rules to create where 'self' is defined | `` | no | +| computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | `` | no | +| computed_ingress_rules | List of computed ingress rules to create by name | `` | no | +| computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | `` | no | +| computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | `` | no | +| computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | `` | no | +| computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | `false` | no | +| create | Whether to create security group and all rules | `true` | no | +| create_db_instance | Whether to create a database instance | `true` | no | +| create_db_option_group | Whether to create a database option group | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `false` | no | +| database_outbound_acl_rules | Database subnets outbound network ACL rules | `` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | `false` | no | +| description | Description of security group | `Security Group managed by Terraform` | no | +| egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | `` | no | +| egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | `` | no | +| egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `` | no | +| egress_rules | List of egress rules to create by name | `` | no | +| egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | `` | no | +| egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | `` | no | +| egress_with_self | List of egress rules to create where 'self' is defined | `` | no | +| egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | `` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `` | no | +| engine | The database engine to use | - | yes | +| engine_version | The engine version to use | - | yes | +| family | The family of the DB parameter group | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | `null` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | - | yes | +| ingress_cidr_blocks | Bzzzzz | `` | no | +| ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | `` | no | +| ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | `` | no | +| ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | `` | no | +| ingress_rules | List of ingress rules to create by name | `` | no | +| ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | `` | no | +| ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | `` | no | +| ingress_with_self | List of ingress rules to create where 'self' is defined | `` | no | +| ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | `` | no | +| instance_class | The instance type of the RDS instance | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | `false` | no | +| name | Name of security group | - | yes | +| name | The DB name to create. If omitted, no database is created initially | `` | no | +| network | The network | `` | no | +| number_of_computed_egress_rules | Number of computed egress rules to create by name | `0` | no | +| number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | `0` | no | +| number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | `0` | no | +| number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | `0` | no | +| number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | `0` | no | +| number_of_computed_ingress_rules | Number of computed ingress rules to create by name | `0` | no | +| number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | `0` | no | +| number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | `0` | no | +| number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | `0` | no | +| number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | `0` | no | +| option_group_description | The description of the option group | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | `` | no | +| options | A list of Options to apply. | `` | no | +| override_special | | `%` | no | +| parameter_group_description | Description of the DB parameter group to create | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | `` | no | +| parameters | A list of DB parameters (map) to apply | `` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | - | yes | +| port | The port on which the DB accepts connections | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | `true` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | `` | no | +| subnetwork | This is a test | `This +is +a +test +` | no | +| tags | A mapping of tags to assign to all resources | `` | no | +| test_var | This is a test variable | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `` | no | +| use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | `true` | no | +| username | Username for the master DB user | - | yes | +| vpc_id | ID of the VPC where to create security group | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | | +| this_db_instance_address | | +| this_db_instance_arn | | +| this_db_instance_availability_zone | | +| this_db_instance_endpoint | | +| this_db_instance_hosted_zone_id | | +| this_db_instance_id | | +| this_db_instance_name | | +| this_db_instance_password | | +| this_db_instance_port | | +| this_db_instance_resource_id | | +| this_db_instance_status | | +| this_db_instance_username | | +| this_db_option_group_arn | | +| this_db_option_group_id | # DB option group | +| this_db_parameter_group_arn | | +| this_db_parameter_group_id | | +| this_db_subnet_group_arn | | +| this_db_subnet_group_id | | +| this_security_group_description | | +| this_security_group_id | | +| this_security_group_name | | +| this_security_group_owner_id | | +| this_security_group_vpc_id | | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.1.1.md b/tests/output/replace/0.12/TEST-0.1.1.md new file mode 100644 index 0000000..1df2a59 --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.1.1.md @@ -0,0 +1,149 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | number | `1` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| computed_egress_rules | List of computed egress rules to create by name | list(string) | `` | no | +| computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | `` | no | +| computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| computed_ingress_rules | List of computed ingress rules to create by name | list(string) | `` | no | +| computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | `` | no | +| computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | `false` | no | +| create | Whether to create security group and all rules | bool | `true` | no | +| create_db_instance | Whether to create a database instance | bool | `true` | no | +| create_db_option_group | Whether to create a database option group | bool | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | bool | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | bool | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | `false` | no | +| database_outbound_acl_rules | Database subnets outbound network ACL rules | list(map(string)) | `` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | bool | `false` | no | +| description | Description of security group | string | `Security Group managed by Terraform` | no | +| egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | `` | no | +| egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | `` | no | +| egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | `` | no | +| egress_rules | List of egress rules to create by name | list(string) | `` | no | +| egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | `` | no | +| egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | `` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `null` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| ingress_cidr_blocks | Bzzzzz | list | `` | no | +| ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | `` | no | +| ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | `` | no | +| ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | `` | no | +| ingress_rules | List of ingress rules to create by name | list(string) | `` | no | +| ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | `` | no | +| ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | bool | `false` | no | +| name | Name of security group | string | - | yes | +| name | The DB name to create. If omitted, no database is created initially | string | `` | no | +| network | The network | object | `` | no | +| number_of_computed_egress_rules | Number of computed egress rules to create by name | number | `0` | no | +| number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | `0` | no | +| number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | `0` | no | +| number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | `0` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | any | `` | no | +| override_special | | string | `%` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list(map(string)) | `` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | bool | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | `true` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | bool | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list(string) | `` | no | +| subnetwork | This is a test | string | `This +is +a +test +` | no | +| tags | A mapping of tags to assign to all resources | map(string) | `` | no | +| test_var | This is a test variable | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | `` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | bool | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_id | ID of the VPC where to create security group | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | list(string) | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | DB option group | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | The db parameter group id | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group name | +| this_security_group_description | The description of the security group | +| this_security_group_id | The ID of the security group | +| this_security_group_name | The name of the security group | +| this_security_group_owner_id | The owner ID | +| this_security_group_vpc_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.2.0.md b/tests/output/replace/0.12/TEST-0.2.0.md new file mode 100644 index 0000000..1df2a59 --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.2.0.md @@ -0,0 +1,149 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | number | `1` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| computed_egress_rules | List of computed egress rules to create by name | list(string) | `` | no | +| computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | `` | no | +| computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| computed_ingress_rules | List of computed ingress rules to create by name | list(string) | `` | no | +| computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | `` | no | +| computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | `false` | no | +| create | Whether to create security group and all rules | bool | `true` | no | +| create_db_instance | Whether to create a database instance | bool | `true` | no | +| create_db_option_group | Whether to create a database option group | bool | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | bool | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | bool | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | `false` | no | +| database_outbound_acl_rules | Database subnets outbound network ACL rules | list(map(string)) | `` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | bool | `false` | no | +| description | Description of security group | string | `Security Group managed by Terraform` | no | +| egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | `` | no | +| egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | `` | no | +| egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | `` | no | +| egress_rules | List of egress rules to create by name | list(string) | `` | no | +| egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | `` | no | +| egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | `` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `null` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| ingress_cidr_blocks | Bzzzzz | list | `` | no | +| ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | `` | no | +| ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | `` | no | +| ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | `` | no | +| ingress_rules | List of ingress rules to create by name | list(string) | `` | no | +| ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | `` | no | +| ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | bool | `false` | no | +| name | Name of security group | string | - | yes | +| name | The DB name to create. If omitted, no database is created initially | string | `` | no | +| network | The network | object | `` | no | +| number_of_computed_egress_rules | Number of computed egress rules to create by name | number | `0` | no | +| number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | `0` | no | +| number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | `0` | no | +| number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | `0` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | any | `` | no | +| override_special | | string | `%` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list(map(string)) | `` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | bool | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | `true` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | bool | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list(string) | `` | no | +| subnetwork | This is a test | string | `This +is +a +test +` | no | +| tags | A mapping of tags to assign to all resources | map(string) | `` | no | +| test_var | This is a test variable | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | `` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | bool | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_id | ID of the VPC where to create security group | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | list(string) | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | DB option group | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | The db parameter group id | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group name | +| this_security_group_description | The description of the security group | +| this_security_group_id | The ID of the security group | +| this_security_group_name | The name of the security group | +| this_security_group_owner_id | The owner ID | +| this_security_group_vpc_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.3.0.md b/tests/output/replace/0.12/TEST-0.3.0.md new file mode 100644 index 0000000..86dc477 --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.3.0.md @@ -0,0 +1,145 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | number | `1` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| computed_egress_rules | List of computed egress rules to create by name | list(string) | `` | no | +| computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | `` | no | +| computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| computed_ingress_rules | List of computed ingress rules to create by name | list(string) | `` | no | +| computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | `` | no | +| computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | `false` | no | +| create | Whether to create security group and all rules | bool | `true` | no | +| create_db_instance | Whether to create a database instance | bool | `true` | no | +| create_db_option_group | Whether to create a database option group | bool | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | bool | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | bool | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | `false` | no | +| database_outbound_acl_rules | Database subnets outbound network ACL rules | list(map(string)) | `` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | bool | `false` | no | +| description | Description of security group | string | `Security Group managed by Terraform` | no | +| egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | `` | no | +| egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | `` | no | +| egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | `` | no | +| egress_rules | List of egress rules to create by name | list(string) | `` | no | +| egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | `` | no | +| egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | `` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `null` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| ingress_cidr_blocks | Bzzzzz | list | `` | no | +| ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | `` | no | +| ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | `` | no | +| ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | `` | no | +| ingress_rules | List of ingress rules to create by name | list(string) | `` | no | +| ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `` | no | +| ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `` | no | +| ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | `` | no | +| ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `` | no | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | bool | `false` | no | +| name | Name of security group | string | - | yes | +| name | The DB name to create. If omitted, no database is created initially | string | `` | no | +| network | The network | object | `` | no | +| number_of_computed_egress_rules | Number of computed egress rules to create by name | number | `0` | no | +| number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | `0` | no | +| number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | `0` | no | +| number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | `0` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | any | `` | no | +| override_special | | string | `%` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list(map(string)) | `` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | bool | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | `true` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | bool | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list(string) | `` | no | +| subnetwork | This is a test | string | `This is a test ` | no | +| tags | A mapping of tags to assign to all resources | map(string) | `` | no | +| test_var | This is a test variable | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | `` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | bool | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_id | ID of the VPC where to create security group | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | list(string) | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | DB option group | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | The db parameter group id | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group name | +| this_security_group_description | The description of the security group | +| this_security_group_id | The ID of the security group | +| this_security_group_name | The name of the security group | +| this_security_group_owner_id | The owner ID | +| this_security_group_vpc_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.4.0.md b/tests/output/replace/0.12/TEST-0.4.0.md new file mode 100644 index 0000000..6046ae4 --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.4.0.md @@ -0,0 +1,149 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | number | `1` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| computed_egress_rules | List of computed egress rules to create by name | list(string) | `[]` | no | +| computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| computed_ingress_rules | List of computed ingress rules to create by name | list(string) | `[]` | no | +| computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | `false` | no | +| create | Whether to create security group and all rules | bool | `true` | no | +| create_db_instance | Whether to create a database instance | bool | `true` | no | +| create_db_option_group | Whether to create a database option group | bool | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | bool | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | bool | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | `false` | no | +| database_outbound_acl_rules | Database subnets outbound network ACL rules | list(map(string)) | `[ { "cidr_block": "0.0.0.0/0", "from_port": 0, "protocol": "-1", "rule_action": "allow", "rule_number": 100, "to_port": 0 } ]` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | bool | `false` | no | +| description | Description of security group | string | `Security Group managed by Terraform` | no | +| egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | `[ "0.0.0.0/0" ]` | no | +| egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | `[ "::/0" ]` | no | +| egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | `[]` | no | +| egress_rules | List of egress rules to create by name | list(string) | `[]` | no | +| egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | `[]` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `null` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| ingress_cidr_blocks | Bzzzzz | list | `[ { "cidr_blocks": "10.0.0.0/32", "description": "SG", "from_port": 22, "protocol": "tcp", "to_port": 22 } ]` | no | +| ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | `[]` | no | +| ingress_rules | List of ingress rules to create by name | list(string) | `[]` | no | +| ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | bool | `false` | no | +| name | Name of security group | string | - | yes | +| name | The DB name to create. If omitted, no database is created initially | string | `` | no | +| network | The network | object | `{ "subnets": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ], "vpc": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ] }` | no | +| number_of_computed_egress_rules | Number of computed egress rules to create by name | number | `0` | no | +| number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | `0` | no | +| number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | `0` | no | +| number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | `0` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | any | `[]` | no | +| override_special | - | string | `%` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list(map(string)) | `[]` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | bool | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | `true` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | bool | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list(string) | `[]` | no | +| subnetwork | This is a test | string | `This +is +a +test +` | no | +| tags | A mapping of tags to assign to all resources | map(string) | `{}` | no | +| test_var | This is a test variable | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | bool | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_id | ID of the VPC where to create security group | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | list(string) | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | The db option group id | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | The db parameter group id | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group name | +| this_security_group_description | The description of the security group | +| this_security_group_id | The ID of the security group | +| this_security_group_name | The name of the security group | +| this_security_group_owner_id | The owner ID | +| this_security_group_vpc_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.4.5.md b/tests/output/replace/0.12/TEST-0.4.5.md new file mode 100644 index 0000000..7223bee --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.4.5.md @@ -0,0 +1,148 @@ +# Test + +Stuff before terraform-docs + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | number | `1` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| computed_egress_rules | List of computed egress rules to create by name | list(string) | `[]` | no | +| computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| computed_ingress_rules | List of computed ingress rules to create by name | list(string) | `[]` | no | +| computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | `false` | no | +| create | Whether to create security group and all rules | bool | `true` | no | +| create_db_instance | Whether to create a database instance | bool | `true` | no | +| create_db_option_group | Whether to create a database option group | bool | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | bool | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | bool | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | `false` | no | +| database_outbound_acl_rules | Database subnets outbound network ACL rules | list(map(string)) | `[ { "cidr_block": "0.0.0.0/0", "from_port": 0, "protocol": "-1", "rule_action": "allow", "rule_number": 100, "to_port": 0 } ]` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | bool | `false` | no | +| description | Description of security group | string | `Security Group managed by Terraform` | no | +| egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | `[ "0.0.0.0/0" ]` | no | +| egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | `[ "::/0" ]` | no | +| egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | `[]` | no | +| egress_rules | List of egress rules to create by name | list(string) | `[]` | no | +| egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | `[]` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `null` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| ingress_cidr_blocks | Bzzzzz | list | `[ { "cidr_blocks": "10.0.0.0/32", "description": "SG", "from_port": 22, "protocol": "tcp", "to_port": 22 } ]` | no | +| ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | `[]` | no | +| ingress_rules | List of ingress rules to create by name | list(string) | `[]` | no | +| ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | bool | `false` | no | +| name | Name of security group | string | - | yes | +| name | The DB name to create. If omitted, no database is created initially | string | `` | no | +| network | The network | object | `{ "subnets": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ], "vpc": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ] }` | no | +| number_of_computed_egress_rules | Number of computed egress rules to create by name | number | `0` | no | +| number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | `0` | no | +| number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | `0` | no | +| number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | `0` | no | +| number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | `0` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | any | `[]` | no | +| override_special | - | string | `%` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list(map(string)) | `[]` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | bool | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | `true` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | bool | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list(string) | `[]` | no | +| subnetwork | This is a test | string | `This +is +a +test +` | no | +| tags | A mapping of tags to assign to all resources | map(string) | `{}` | no | +| test_var | This is a test variable | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | bool | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_id | ID of the VPC where to create security group | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | list(string) | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | The db option group id | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | The db parameter group id | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group name | +| this_security_group_description | The description of the security group | +| this_security_group_id | The ID of the security group | +| this_security_group_name | The name of the security group | +| this_security_group_owner_id | The owner ID | +| this_security_group_vpc_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.5.0.md b/tests/output/replace/0.12/TEST-0.5.0.md new file mode 100644 index 0000000..47165ed --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.5.0.md @@ -0,0 +1,148 @@ +# Test + +Stuff before terraform-docs + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated\_storage | The allocated storage in gigabytes | string | - | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| engine | The database engine to use | string | - | yes | +| engine\_version | The engine version to use | string | - | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| instance\_class | The instance type of the RDS instance | string | - | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| name | Name of security group | string | - | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| username | Username for the master DB user | string | - | yes | +| vpc\_id | ID of the VPC where to create security group | string | - | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup\_retention\_period | The days to retain backups for | number | `1` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | list(string) | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | list(string) | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | `false` | no | +| create | Whether to create security group and all rules | bool | `true` | no | +| create\_db\_instance | Whether to create a database instance | bool | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | bool | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | bool | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | bool | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | `false` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | list(map(string)) | `[ { "cidr_block": "0.0.0.0/0", "from_port": 0, "protocol": "-1", "rule_action": "allow", "rule_number": 100, "to_port": 0 } ]` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | bool | `false` | no | +| description | Description of security group | string | `Security Group managed by Terraform` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | `[ "0.0.0.0/0" ]` | no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | `[ "::/0" ]` | no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | `[]` | no | +| egress\_rules | List of egress rules to create by name | list(string) | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | `[]` | no | +| family | The family of the DB parameter group | string | `` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `null` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `false` | no | +| ingress\_cidr\_blocks | Bzzzzz | list | `[ { "cidr_blocks": "10.0.0.0/32", "description": "SG", "from_port": 22, "protocol": "tcp", "to_port": 22 } ]` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | list(string) | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | bool | `false` | no | +| name | The DB name to create. If omitted, no database is created initially | string | `` | no | +| network | The network | object | `{ "subnets": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ], "vpc": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ] }` | no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | number | `0` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | number | `0` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | `0` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | number | `0` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | `0` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | `0` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | number | `0` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | `0` | no | +| option\_group\_description | The description of the option group | string | `` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | any | `[]` | no | +| override\_special | - | string | `%` | no | +| parameter\_group\_description | Description of the DB parameter group to create | string | `` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list(map(string)) | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | bool | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | `true` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | bool | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet\_ids | A list of VPC subnet IDs | list(string) | `[]` | no | +| subnetwork | This is a test | string | `This +is +a +test +` | no | +| tags | A mapping of tags to assign to all resources | map(string) | `{}` | no | +| test\_var | This is a test variable | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use\_name\_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | bool | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | list(string) | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.6.0.md b/tests/output/replace/0.12/TEST-0.6.0.md new file mode 100644 index 0000000..92477fd --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.6.0.md @@ -0,0 +1,144 @@ +# Test + +Stuff before terraform-docs + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated\_storage | The allocated storage in gigabytes | string | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | n/a | yes | +| engine | The database engine to use | string | n/a | yes | +| engine\_version | The engine version to use | string | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | n/a | yes | +| instance\_class | The instance type of the RDS instance | string | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | n/a | yes | +| name | Name of security group | string | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | n/a | yes | +| port | The port on which the DB accepts connections | string | n/a | yes | +| username | Username for the master DB user | string | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | string | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | `"false"` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | `"false"` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | `"true"` | no | +| availability\_zone | The Availability Zone of the RDS instance | string | `""` | no | +| backup\_retention\_period | The days to retain backups for | number | `"1"` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | list(string) | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | list(string) | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | `"false"` | no | +| create | Whether to create security group and all rules | bool | `"true"` | no | +| create\_db\_instance | Whether to create a database instance | bool | `"true"` | no | +| create\_db\_option\_group | Whether to create a database option group | bool | `"true"` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | bool | `"true"` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | bool | `"true"` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | `"false"` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | list(map(string)) | `[ { "cidr_block": "0.0.0.0/0", "from_port": 0, "protocol": "-1", "rule_action": "allow", "rule_number": 100, "to_port": 0 } ]` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | bool | `"false"` | no | +| description | Description of security group | string | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | `[ "0.0.0.0/0" ]` | no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | `[ "::/0" ]` | no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | `[]` | no | +| egress\_rules | List of egress rules to create by name | list(string) | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | `[]` | no | +| family | The family of the DB parameter group | string | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `"null"` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | bool | `"false"` | no | +| ingress\_cidr\_blocks | Bzzzzz | list | `[ { "cidr_blocks": "10.0.0.0/32", "description": "SG", "from_port": 22, "protocol": "tcp", "to_port": 22 } ]` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | list(string) | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | `"0"` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | `"0"` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | bool | `"false"` | no | +| name | The DB name to create. If omitted, no database is created initially | string | `""` | no | +| network | The network | object | `{ "subnets": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ], "vpc": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ] }` | no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | number | `"0"` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | `"0"` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | `"0"` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | number | `"0"` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | `"0"` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | number | `"0"` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | `"0"` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | `"0"` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | number | `"0"` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | `"0"` | no | +| option\_group\_description | The description of the option group | string | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `""` | no | +| options | A list of Options to apply. | any | `[]` | no | +| override\_special | | string | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | string | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | string | `""` | no | +| parameters | A list of DB parameters (map) to apply | list(map(string)) | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | bool | `"false"` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | `"true"` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | bool | `"false"` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | list(string) | `[]` | no | +| subnetwork | This is a test | string | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | map(string) | `{}` | no | +| test\_var | This is a test variable | string | `""` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `""` | no | +| use\_name\_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | `"true"` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | bool | `"true"` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | list(string) | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.7.0.md b/tests/output/replace/0.12/TEST-0.7.0.md new file mode 100644 index 0000000..21108de --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.7.0.md @@ -0,0 +1,144 @@ +# Test + +Stuff before terraform-docs + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated\_storage | The allocated storage in gigabytes | string | n/a | yes | +| backup\_window | The daily time range \(in UTC\) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | string | n/a | yes | +| engine | The database engine to use | string | n/a | yes | +| engine\_version | The engine version to use | string | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | n/a | yes | +| instance\_class | The instance type of the RDS instance | string | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | n/a | yes | +| name | Name of security group | string | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | n/a | yes | +| port | The port on which the DB accepts connections | string | n/a | yes | +| username | Username for the master DB user | string | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | string | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | `"false"` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | `"false"` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | `"true"` | no | +| availability\_zone | The Availability Zone of the RDS instance | string | `""` | no | +| backup\_retention\_period | The days to retain backups for | number | `"1"` | no | +| character\_set\_name | \(Optional\) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | list(string) | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | list(map(string)) | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | list(map(string)) | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source\_security\_group\_id' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | list(string) | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr\_blocks' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | list(map(string)) | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot \(if final\_snapshot\_identifier is specified\) | bool | `"false"` | no | +| create | Whether to create security group and all rules | bool | `"true"` | no | +| create\_db\_instance | Whether to create a database instance | bool | `"true"` | no | +| create\_db\_option\_group | Whether to create a database option group | bool | `"true"` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | bool | `"true"` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | bool | `"true"` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | `"false"` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | list(map(string)) | `[ { "cidr_block": "0.0.0.0/0", "from_port": 0, "protocol": "-1", "rule_action": "allow", "rule_number": 100, "to_port": 0 } ]` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | bool | `"false"` | no | +| description | Description of security group | string | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | `[ "0.0.0.0/0" ]` | no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | `[ "::/0" ]` | no | +| egress\_prefix\_list\_ids | List of prefix list IDs \(for allowing access to VPC endpoints\) to use on all egress rules | list(string) | `[]` | no | +| egress\_rules | List of egress rules to create by name | list(string) | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | list(map(string)) | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | list(map(string)) | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | list(map(string)) | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values \(depending on engine\): alert, audit, error, general, listener, slowquery, trace, postgresql \(PostgreSQL\), upgrade \(PostgreSQL\). | list(string) | `[]` | no | +| family | The family of the DB parameter group | string | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `"null"` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management \(IAM\) accounts to database accounts is enabled | bool | `"false"` | no | +| ingress\_cidr\_blocks | Bzzzzz | list | `[ { "cidr_blocks": "10.0.0.0/32", "description": "SG", "from_port": 22, "protocol": "tcp", "to_port": 22 } ]` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs \(for allowing access to VPC endpoints\) to use on all ingress rules | list(string) | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | list(string) | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | list(map(string)) | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | list(map(string)) | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | list(map(string)) | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source\_security\_group\_id' is used | list(map(string)) | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | number | `"0"` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | string | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | `"0"` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | string | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | string | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | bool | `"false"` | no | +| name | The DB name to create. If omitted, no database is created initially | string | `""` | no | +| network | The network | object | `{ "subnets": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ], "vpc": [ { "cidr_block": "10.0.0.0/16", "id": "vpc-123456" } ] }` | no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | number | `"0"` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | number | `"0"` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | number | `"0"` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | number | `"0"` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source\_security\_group\_id' is used | number | `"0"` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | number | `"0"` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr\_blocks' is used | number | `"0"` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | number | `"0"` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | number | `"0"` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | number | `"0"` | no | +| option\_group\_description | The description of the option group | string | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | string | `""` | no | +| options | A list of Options to apply. | any | `[]` | no | +| override\_special | | string | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | string | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | string | `""` | no | +| parameters | A list of DB parameters \(map\) to apply | list(map(string)) | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | bool | `"false"` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | bool | `"true"` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | bool | `"false"` | no | +| storage\_type | One of 'standard' \(magnetic\), 'gp2' \(general purpose SSD\), or 'io1' \(provisioned IOPS SSD\). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | list(string) | `[]` | no | +| subnetwork | This is a test | string | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | map(string) | `{}` | no | +| test\_var | This is a test variable | string | `""` | no | +| timeouts | \(Optional\) Updated Terraform resource management timeouts. Applies to `aws\_db\_instance` in particular to permit resource management times | map(string) | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | \(Optional\) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `""` | no | +| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | `"true"` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | bool | `"true"` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | list(string) | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance \(to be used in a Route 53 Alias record\) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password \(this password may be old, because Terraform doesn't track it after initial creation\) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.8.0-rc.1.md b/tests/output/replace/0.12/TEST-0.8.0-rc.1.md new file mode 100644 index 0000000..1d7d55c --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.8.0-rc.1.md @@ -0,0 +1,146 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `string` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `string` | n/a | yes | +| engine | The database engine to use | `string` | n/a | yes | +| engine\_version | The engine version to use | `string` | n/a | yes | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `string` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `string` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `string` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `string` | n/a | yes | +| name | Name of security group | `string` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `string` | n/a | yes | +| port | The port on which the DB accepts connections | `string` | n/a | yes | +| username | Username for the master DB user | `string` | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | `string` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `1` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | `list(string)` | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | `list(string)` | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create | Whether to create security group and all rules | `bool` | `true` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
 | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| description | Description of security group | `string` | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
 | no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
 | no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `list(string)` | `[]` | no | +| egress\_rules | List of egress rules to create by name | `list(string)` | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list(string)` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | `list(string)` | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
 | 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
 | no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| override\_special | n/a | `string` | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list(map(string))` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `true` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list(string)` | `[]` | no | +| subnetwork | This is a test | `string` | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | `map(string)` | `{}` | no | +| test\_var | This is a test variable | `string` | `""` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws\_db\_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
 | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list(string)` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.8.0-rc.2.md b/tests/output/replace/0.12/TEST-0.8.0-rc.2.md new file mode 100644 index 0000000..07fcb39 --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.8.0-rc.2.md @@ -0,0 +1,146 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `string` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `string` | n/a | yes | +| engine | The database engine to use | `string` | n/a | yes | +| engine\_version | The engine version to use | `string` | n/a | yes | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `string` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `string` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `string` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `string` | n/a | yes | +| name | Name of security group | `string` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `string` | n/a | yes | +| port | The port on which the DB accepts connections | `string` | n/a | yes | +| username | Username for the master DB user | `string` | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | `string` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `1` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | `list(string)` | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | `list(string)` | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create | Whether to create security group and all rules | `bool` | `true` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
 | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| description | Description of security group | `string` | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
 | no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
 | no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `list(string)` | `[]` | no | +| egress\_rules | List of egress rules to create by name | `list(string)` | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list(string)` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | `list(string)` | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
 | 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
 | no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| override\_special | n/a | `string` | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list(map(string))` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `true` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list(string)` | `[]` | no | +| subnetwork | This is a test | `string` | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | `map(string)` | `{}` | no | +| test\_var | This is a test variable | `string` | `""` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
 | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list(string)` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.8.0-rc.3.md b/tests/output/replace/0.12/TEST-0.8.0-rc.3.md new file mode 100644 index 0000000..b6d868b --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.8.0-rc.3.md @@ -0,0 +1,146 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `string` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `string` | n/a | yes | +| engine | The database engine to use | `string` | n/a | yes | +| engine\_version | The engine version to use | `string` | n/a | yes | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `string` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `string` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `string` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `string` | n/a | yes | +| name | Name of security group | `string` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `string` | n/a | yes | +| port | The port on which the DB accepts connections | `string` | n/a | yes | +| username | Username for the master DB user | `string` | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | `string` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `1` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | `list(string)` | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | `list(string)` | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create | Whether to create security group and all rules | `bool` | `true` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
| no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| description | Description of security group | `string` | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
| no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
| no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `list(string)` | `[]` | no | +| egress\_rules | List of egress rules to create by name | `list(string)` | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list(string)` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | `list(string)` | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
| 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
| no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| override\_special | n/a | `string` | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list(map(string))` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `true` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list(string)` | `[]` | no | +| subnetwork | This is a test | `string` | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | `map(string)` | `{}` | no | +| test\_var | This is a test variable | `string` | `""` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list(string)` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.8.0.md b/tests/output/replace/0.12/TEST-0.8.0.md new file mode 100644 index 0000000..97d7530 --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.8.0.md @@ -0,0 +1,146 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `string` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `string` | n/a | yes | +| engine | The database engine to use | `string` | n/a | yes | +| engine\_version | The engine version to use | `string` | n/a | yes | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `string` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `string` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `string` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `string` | n/a | yes | +| name | Name of security group | `string` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `string` | n/a | yes | +| port | The port on which the DB accepts connections | `string` | n/a | yes | +| username | Username for the master DB user | `string` | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | `string` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `1` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | `list(string)` | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | `list(string)` | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create | Whether to create security group and all rules | `bool` | `true` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
| no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| description | Description of security group | `string` | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
| no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
| no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `list(string)` | `[]` | no | +| egress\_rules | List of egress rules to create by name | `list(string)` | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list(string)` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | `list(string)` | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
| 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
| no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| override\_special | n/a | `string` | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list(map(string))` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `true` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list(string)` | `[]` | no | +| subnetwork | This
is
a
test | `string` | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | `map(string)` | `{}` | no | +| test\_var | This is a test variable | `string` | `""` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list(string)` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/0.12/TEST-0.8.1.md b/tests/output/replace/0.12/TEST-0.8.1.md new file mode 100644 index 0000000..30c429c --- /dev/null +++ b/tests/output/replace/0.12/TEST-0.8.1.md @@ -0,0 +1,146 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `string` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `string` | n/a | yes | +| engine | The database engine to use | `string` | n/a | yes | +| engine\_version | The engine version to use | `string` | n/a | yes | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `string` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `string` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `string` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `string` | n/a | yes | +| name | Name of security group | `string` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `string` | n/a | yes | +| port | The port on which the DB accepts connections | `string` | n/a | yes | +| username | Username for the master DB user | `string` | n/a | yes | +| vpc\_id | ID of the VPC where to create security group | `string` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `1` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| computed\_egress\_rules | List of computed egress rules to create by name | `list(string)` | `[]` | no | +| computed\_egress\_with\_cidr\_blocks | List of computed egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_ipv6\_cidr\_blocks | List of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_self | List of computed egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_egress\_with\_source\_security\_group\_id | List of computed egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_rules | List of computed ingress rules to create by name | `list(string)` | `[]` | no | +| computed\_ingress\_with\_cidr\_blocks | List of computed ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_ipv6\_cidr\_blocks | List of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_self | List of computed ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| computed\_ingress\_with\_source\_security\_group\_id | List of computed ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create | Whether to create security group and all rules | `bool` | `true` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| database\_outbound\_acl\_rules | Database subnets outbound network ACL rules | `list(map(string))` | 
[
  {
    "cidr_block": "0.0.0.0/0",
    "from_port": 0,
    "protocol": "-1",
    "rule_action": "allow",
    "rule_number": 100,
    "to_port": 0
  }
]
| no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| description | Description of security group | `string` | `"Security Group managed by Terraform"` | no | +| egress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "0.0.0.0/0"
]
| no | +| egress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all egress rules | `list(string)` | 
[
  "::/0"
]
| no | +| egress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | `list(string)` | `[]` | no | +| egress\_rules | List of egress rules to create by name | `list(string)` | `[]` | no | +| egress\_with\_cidr\_blocks | List of egress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_ipv6\_cidr\_blocks | List of egress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| egress\_with\_self | List of egress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| egress\_with\_source\_security\_group\_id | List of egress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list(string)` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| ingress\_cidr\_blocks | List of IPv4 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_ipv6\_cidr\_blocks | List of IPv6 CIDR ranges to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_prefix\_list\_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | `list(string)` | `[]` | no | +| ingress\_rules | List of ingress rules to create by name | `list(string)` | `[]` | no | +| ingress\_with\_cidr\_blocks | List of ingress rules to create where 'cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_ipv6\_cidr\_blocks | List of ingress rules to create where 'ipv6\_cidr\_blocks' is used | `list(map(string))` | `[]` | no | +| ingress\_with\_self | List of ingress rules to create where 'self' is defined | `list(map(string))` | `[]` | no | +| ingress\_with\_source\_security\_group\_id | List of ingress rules to create where 'source\_security\_group\_id' is used | `list(map(string))` | `[]` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| network | The network | 
object({
    vpc = object({
      id         = string
      cidr_block = string
    })
    subnets = set(object({
      id         = string
      cidr_block = string
    }))
  })
| 
{
  "subnets": [
    {
      "cidr_block": "10.0.0.0/16",
      "id": "vpc-123456"
    }
  ],
  "vpc": {
    "cidr_block": "10.0.0.0/16",
    "id": "vpc-123456"
  }
}
| no | +| number\_of\_computed\_egress\_rules | Number of computed egress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_cidr\_blocks | Number of computed egress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_ipv6\_cidr\_blocks | Number of computed egress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_self | Number of computed egress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_egress\_with\_source\_security\_group\_id | Number of computed egress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_rules | Number of computed ingress rules to create by name | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_cidr\_blocks | Number of computed ingress rules to create where 'cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_ipv6\_cidr\_blocks | Number of computed ingress rules to create where 'ipv6\_cidr\_blocks' is used | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_self | Number of computed ingress rules to create where 'self' is defined | `number` | `0` | no | +| number\_of\_computed\_ingress\_with\_source\_security\_group\_id | Number of computed ingress rules to create where 'source\_security\_group\_id' is used | `number` | `0` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `any` | `[]` | no | +| override\_special | n/a | `string` | `"%"` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list(map(string))` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `true` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list(string)` | `[]` | no | +| subnetwork | This
is
a
test | `string` | `"This\nis\na\ntest\n"` | no | +| tags | A mapping of tags to assign to all resources | `map(string)` | `{}` | no | +| test\_var | This is a test variable | `string` | `""` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map(string)` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_name\_prefix | Whether to use name\_prefix or fixed name. Should be true to able to update security group name after initial creation | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list(string)` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| environment | The output | +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group name | +| this\_security\_group\_description | The description of the security group | +| this\_security\_group\_id | The ID of the security group | +| this\_security\_group\_name | The name of the security group | +| this\_security\_group\_owner\_id | The owner ID | +| this\_security\_group\_vpc\_id | The VPC ID | + + + +Stuff after terraform-docs diff --git a/tests/0.12/TEST-latest.md b/tests/output/replace/0.12/TEST-latest.md similarity index 100% rename from tests/0.12/TEST-latest.md rename to tests/output/replace/0.12/TEST-latest.md diff --git a/tests/output/replace/0.12/main.tf b/tests/output/replace/0.12/main.tf new file mode 120000 index 0000000..33bbb94 --- /dev/null +++ b/tests/output/replace/0.12/main.tf @@ -0,0 +1 @@ +../../../input/0.12/main.tf \ No newline at end of file diff --git a/tests/output/replace/basic/TEST-0.1.0.md b/tests/output/replace/basic/TEST-0.1.0.md new file mode 100644 index 0000000..11327b8 --- /dev/null +++ b/tests/output/replace/basic/TEST-0.1.0.md @@ -0,0 +1,9 @@ + + +## Inputs + +| Name | Description | Default | Required | +|------|-------------|:-----:|:-----:| +| test | test description | - | yes | + + diff --git a/tests/output/replace/basic/TEST-0.1.1.md b/tests/output/replace/basic/TEST-0.1.1.md new file mode 100644 index 0000000..3de12e8 --- /dev/null +++ b/tests/output/replace/basic/TEST-0.1.1.md @@ -0,0 +1,9 @@ + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| test | test description | string | - | yes | + + diff --git a/tests/output/replace/basic/TEST-0.2.0.md b/tests/output/replace/basic/TEST-0.2.0.md new file mode 100644 index 0000000..3de12e8 --- /dev/null +++ b/tests/output/replace/basic/TEST-0.2.0.md @@ -0,0 +1,9 @@ + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| test | test description | string | - | yes | + + diff --git a/tests/output/replace/basic/TEST-0.3.0.md b/tests/output/replace/basic/TEST-0.3.0.md new file mode 100644 index 0000000..3de12e8 --- /dev/null +++ b/tests/output/replace/basic/TEST-0.3.0.md @@ -0,0 +1,9 @@ + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| test | test description | string | - | yes | + + diff --git a/tests/output/replace/basic/TEST-0.4.0.md b/tests/output/replace/basic/TEST-0.4.0.md new file mode 100644 index 0000000..3de12e8 --- /dev/null +++ b/tests/output/replace/basic/TEST-0.4.0.md @@ -0,0 +1,9 @@ + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| test | test description | string | - | yes | + + diff --git a/tests/output/replace/basic/TEST-0.4.5.md b/tests/output/replace/basic/TEST-0.4.5.md new file mode 100644 index 0000000..c5b33ef --- /dev/null +++ b/tests/output/replace/basic/TEST-0.4.5.md @@ -0,0 +1,8 @@ + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| test | test description | string | - | yes | + + diff --git a/tests/output/replace/basic/TEST-0.5.0.md b/tests/output/replace/basic/TEST-0.5.0.md new file mode 100644 index 0000000..c5b33ef --- /dev/null +++ b/tests/output/replace/basic/TEST-0.5.0.md @@ -0,0 +1,8 @@ + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| test | test description | string | - | yes | + + diff --git a/tests/output/replace/basic/TEST-0.6.0.md b/tests/output/replace/basic/TEST-0.6.0.md new file mode 100644 index 0000000..ba2bcfc --- /dev/null +++ b/tests/output/replace/basic/TEST-0.6.0.md @@ -0,0 +1,8 @@ + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| test | test description | string | n/a | yes | + + diff --git a/tests/output/replace/basic/TEST-0.7.0.md b/tests/output/replace/basic/TEST-0.7.0.md new file mode 100644 index 0000000..ba2bcfc --- /dev/null +++ b/tests/output/replace/basic/TEST-0.7.0.md @@ -0,0 +1,8 @@ + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| test | test description | string | n/a | yes | + + diff --git a/tests/basic/TEST-latest.md b/tests/output/replace/basic/TEST-0.8.0-rc.1.md similarity index 100% rename from tests/basic/TEST-latest.md rename to tests/output/replace/basic/TEST-0.8.0-rc.1.md diff --git a/tests/output/replace/basic/TEST-0.8.0-rc.2.md b/tests/output/replace/basic/TEST-0.8.0-rc.2.md new file mode 100644 index 0000000..0fb6f5d --- /dev/null +++ b/tests/output/replace/basic/TEST-0.8.0-rc.2.md @@ -0,0 +1,16 @@ + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| test | test description | `any` | n/a | yes | + +## Outputs + +No output. + + diff --git a/tests/output/replace/basic/TEST-0.8.0-rc.3.md b/tests/output/replace/basic/TEST-0.8.0-rc.3.md new file mode 100644 index 0000000..0fb6f5d --- /dev/null +++ b/tests/output/replace/basic/TEST-0.8.0-rc.3.md @@ -0,0 +1,16 @@ + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| test | test description | `any` | n/a | yes | + +## Outputs + +No output. + + diff --git a/tests/output/replace/basic/TEST-0.8.0.md b/tests/output/replace/basic/TEST-0.8.0.md new file mode 100644 index 0000000..0fb6f5d --- /dev/null +++ b/tests/output/replace/basic/TEST-0.8.0.md @@ -0,0 +1,16 @@ + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| test | test description | `any` | n/a | yes | + +## Outputs + +No output. + + diff --git a/tests/output/replace/basic/TEST-0.8.1.md b/tests/output/replace/basic/TEST-0.8.1.md new file mode 100644 index 0000000..0fb6f5d --- /dev/null +++ b/tests/output/replace/basic/TEST-0.8.1.md @@ -0,0 +1,16 @@ + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| test | test description | `any` | n/a | yes | + +## Outputs + +No output. + + diff --git a/tests/output/replace/basic/TEST-latest.md b/tests/output/replace/basic/TEST-latest.md new file mode 100644 index 0000000..0fb6f5d --- /dev/null +++ b/tests/output/replace/basic/TEST-latest.md @@ -0,0 +1,16 @@ + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| test | test description | `any` | n/a | yes | + +## Outputs + +No output. + + diff --git a/tests/output/replace/basic/main.tf b/tests/output/replace/basic/main.tf new file mode 120000 index 0000000..4a90fb0 --- /dev/null +++ b/tests/output/replace/basic/main.tf @@ -0,0 +1 @@ +../../../input/basic/main.tf \ No newline at end of file diff --git a/tests/output/replace/default/TEST-0.1.0.md b/tests/output/replace/default/TEST-0.1.0.md new file mode 100644 index 0000000..7e3b6a4 --- /dev/null +++ b/tests/output/replace/default/TEST-0.1.0.md @@ -0,0 +1,94 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Default | Required | +|------|-------------|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | `` | no | +| backup_retention_period | The days to retain backups for | `7` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | `false` | no | +| create_db_instance | Whether to create a database instance | `true` | no | +| create_db_option_group | Whether to create a database option group | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `false` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | `false` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `` | no | +| engine | The database engine to use | - | yes | +| engine_version | The engine version to use | - | yes | +| family | The family of the DB parameter group | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | `false` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | - | yes | +| instance_class | The instance type of the RDS instance | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | `` | no | +| option_group_description | The description of the option group | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | `` | no | +| options | A list of Options to apply. | `` | no | +| parameter_group_description | Description of the DB parameter group to create | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | `` | no | +| parameters | A list of DB parameters (map) to apply | `` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | - | yes | +| port | The port on which the DB accepts connections | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | `false` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | `` | no | +| tags | A mapping of tags to assign to all resources | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `` | no | +| use_option_group_name_prefix | Whether to use the option group name prefix or not | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | `true` | no | +| use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | `true` | no | +| username | Username for the master DB user | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this_db_instance_address | | +| this_db_instance_arn | | +| this_db_instance_availability_zone | | +| this_db_instance_endpoint | | +| this_db_instance_hosted_zone_id | | +| this_db_instance_id | | +| this_db_instance_name | | +| this_db_instance_password | | +| this_db_instance_port | | +| this_db_instance_resource_id | | +| this_db_instance_status | | +| this_db_instance_username | | +| this_db_option_group_arn | | +| this_db_option_group_id | | +| this_db_parameter_group_arn | | +| this_db_parameter_group_id | # -------------------------------------------------------------------------------------------------- # RDS Parameter group # -------------------------------------------------------------------------------------------------- | +| this_db_subnet_group_arn | | +| this_db_subnet_group_id | | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.1.1.md b/tests/output/replace/default/TEST-0.1.1.md new file mode 100644 index 0000000..30339e3 --- /dev/null +++ b/tests/output/replace/default/TEST-0.1.1.md @@ -0,0 +1,94 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | string | `7` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | +| create_db_instance | Whether to create a database instance | string | `true` | no | +| create_db_option_group | Whether to create a database option group | string | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | string | `` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | list | `` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | string | `` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list | `` | no | +| tags | A mapping of tags to assign to all resources | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | +| use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | string | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | The db option group id | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | -------------------------------------------------------------------------------------------------- RDS Parameter group -------------------------------------------------------------------------------------------------- | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.2.0.md b/tests/output/replace/default/TEST-0.2.0.md new file mode 100644 index 0000000..30339e3 --- /dev/null +++ b/tests/output/replace/default/TEST-0.2.0.md @@ -0,0 +1,94 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | string | `7` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | +| create_db_instance | Whether to create a database instance | string | `true` | no | +| create_db_option_group | Whether to create a database option group | string | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | string | `` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | list | `` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | string | `` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list | `` | no | +| tags | A mapping of tags to assign to all resources | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | +| use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | string | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | The db option group id | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | -------------------------------------------------------------------------------------------------- RDS Parameter group -------------------------------------------------------------------------------------------------- | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.3.0.md b/tests/output/replace/default/TEST-0.3.0.md new file mode 100644 index 0000000..30339e3 --- /dev/null +++ b/tests/output/replace/default/TEST-0.3.0.md @@ -0,0 +1,94 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | string | `7` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | +| create_db_instance | Whether to create a database instance | string | `true` | no | +| create_db_option_group | Whether to create a database option group | string | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | string | `` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | list | `` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | string | `` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list | `` | no | +| tags | A mapping of tags to assign to all resources | string | `` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | +| use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | string | `` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | The db option group id | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | -------------------------------------------------------------------------------------------------- RDS Parameter group -------------------------------------------------------------------------------------------------- | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.4.0.md b/tests/output/replace/default/TEST-0.4.0.md new file mode 100644 index 0000000..da7bd13 --- /dev/null +++ b/tests/output/replace/default/TEST-0.4.0.md @@ -0,0 +1,94 @@ +# Test + +Stuff before terraform-docs + + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | string | `7` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | +| create_db_instance | Whether to create a database instance | string | `true` | no | +| create_db_option_group | Whether to create a database option group | string | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | list | `[]` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list | `[]` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list | `[]` | no | +| tags | A mapping of tags to assign to all resources | map | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | +| use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | list | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | The db option group id | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | The db parameter group id | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.4.5.md b/tests/output/replace/default/TEST-0.4.5.md new file mode 100644 index 0000000..e924173 --- /dev/null +++ b/tests/output/replace/default/TEST-0.4.5.md @@ -0,0 +1,93 @@ +# Test + +Stuff before terraform-docs + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated_storage | The allocated storage in gigabytes | string | - | yes | +| allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | +| apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | +| auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | +| availability_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup_retention_period | The days to retain backups for | string | `7` | no | +| backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | +| create_db_instance | Whether to create a database instance | string | `true` | no | +| create_db_option_group | Whether to create a database option group | string | `true` | no | +| create_db_parameter_group | Whether to create a database parameter group | string | `true` | no | +| create_db_subnet_group | Whether to create a database subnet group | string | `true` | no | +| create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | +| db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion_protection | The database can't be deleted when this value is set to true. | string | `false` | no | +| enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | +| engine | The database engine to use | string | - | yes | +| engine_version | The engine version to use | string | - | yes | +| family | The family of the DB parameter group | string | `` | no | +| final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | +| iam_database_authentication_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| instance_class | The instance type of the RDS instance | string | - | yes | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | +| kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | +| monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | +| option_group_description | The description of the option group | string | `` | no | +| option_group_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | list | `[]` | no | +| parameter_group_description | Description of the DB parameter group to create | string | `` | no | +| parameter_group_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list | `[]` | no | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| publicly_accessible | Bool to control if instance is publicly accessible | string | `false` | no | +| replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | +| snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | +| storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet_ids | A list of VPC subnet IDs | list | `[]` | no | +| tags | A mapping of tags to assign to all resources | map | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use_option_group_name_prefix | Whether to use the option group name prefix or not | string | `true` | no | +| use_parameter_group_name_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | +| use_subnet_group_name_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | +| username | Username for the master DB user | string | - | yes | +| vpc_security_group_ids | List of VPC security groups to associate | list | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this_db_instance_address | The address of the RDS instance | +| this_db_instance_arn | The ARN of the RDS instance | +| this_db_instance_availability_zone | The availability zone of the RDS instance | +| this_db_instance_endpoint | The connection endpoint | +| this_db_instance_hosted_zone_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this_db_instance_id | The RDS instance ID | +| this_db_instance_name | The database name | +| this_db_instance_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this_db_instance_port | The database port | +| this_db_instance_resource_id | The RDS Resource ID of this instance | +| this_db_instance_status | The RDS instance status | +| this_db_instance_username | The master username for the database | +| this_db_option_group_arn | The ARN of the db option group | +| this_db_option_group_id | The db option group id | +| this_db_parameter_group_arn | The ARN of the db parameter group | +| this_db_parameter_group_id | The db parameter group id | +| this_db_subnet_group_arn | The ARN of the db subnet group | +| this_db_subnet_group_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.5.0.md b/tests/output/replace/default/TEST-0.5.0.md new file mode 100644 index 0000000..09fd18f --- /dev/null +++ b/tests/output/replace/default/TEST-0.5.0.md @@ -0,0 +1,93 @@ +# Test + +Stuff before terraform-docs + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated\_storage | The allocated storage in gigabytes | string | - | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | - | yes | +| engine | The database engine to use | string | - | yes | +| engine\_version | The engine version to use | string | - | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | - | yes | +| instance\_class | The instance type of the RDS instance | string | - | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | - | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | - | yes | +| port | The port on which the DB accepts connections | string | - | yes | +| username | Username for the master DB user | string | - | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | string | `` | no | +| backup\_retention\_period | The days to retain backups for | string | `7` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `false` | no | +| create\_db\_instance | Whether to create a database instance | string | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | string | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | string | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | string | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `false` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | string | `false` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | +| family | The family of the DB parameter group | string | `` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `false` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `false` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `rds-monitoring-role` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | string | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | string | `` | no | +| option\_group\_description | The description of the option group | string | `` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `` | no | +| options | A list of Options to apply. | list | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | string | `` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | string | `` | no | +| parameters | A list of DB parameters (map) to apply | list | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | string | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `false` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | string | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `gp2` | no | +| subnet\_ids | A list of VPC subnet IDs | list | `[]` | no | +| tags | A mapping of tags to assign to all resources | map | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | string | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | string | `true` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | string | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | list | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.6.0.md b/tests/output/replace/default/TEST-0.6.0.md new file mode 100644 index 0000000..9f23684 --- /dev/null +++ b/tests/output/replace/default/TEST-0.6.0.md @@ -0,0 +1,93 @@ +# Test + +Stuff before terraform-docs + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated\_storage | The allocated storage in gigabytes | string | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | n/a | yes | +| engine | The database engine to use | string | n/a | yes | +| engine\_version | The engine version to use | string | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | n/a | yes | +| instance\_class | The instance type of the RDS instance | string | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | n/a | yes | +| port | The port on which the DB accepts connections | string | n/a | yes | +| username | Username for the master DB user | string | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `"false"` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `"false"` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `"true"` | no | +| availability\_zone | The Availability Zone of the RDS instance | string | `""` | no | +| backup\_retention\_period | The days to retain backups for | string | `"7"` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | string | `"false"` | no | +| create\_db\_instance | Whether to create a database instance | string | `"true"` | no | +| create\_db\_option\_group | Whether to create a database option group | string | `"true"` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | string | `"true"` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | string | `"true"` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `"false"` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | string | `"false"` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list | `[]` | no | +| family | The family of the DB parameter group | string | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `"false"` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | string | `"false"` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | string | `"0"` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `"0"` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | string | `"false"` | no | +| name | The DB schema name to create. If omitted, no database is created initially | string | `""` | no | +| option\_group\_description | The description of the option group | string | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option_group creation | string | `""` | no | +| options | A list of Options to apply. | list | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | string | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | string | `""` | no | +| parameters | A list of DB parameters (map) to apply | list | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | string | `"false"` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | string | `"false"` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | string | `"false"` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | list | `[]` | no | +| tags | A mapping of tags to assign to all resources | map | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | string | `"true"` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | string | `"true"` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | string | `"true"` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | list | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.7.0.md b/tests/output/replace/default/TEST-0.7.0.md new file mode 100644 index 0000000..b1c5ccb --- /dev/null +++ b/tests/output/replace/default/TEST-0.7.0.md @@ -0,0 +1,93 @@ +# Test + +Stuff before terraform-docs + + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|:----:|:-----:|:-----:| +| allocated\_storage | The allocated storage in gigabytes | string | n/a | yes | +| backup\_window | The daily time range \(in UTC\) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | string | n/a | yes | +| engine | The database engine to use | string | n/a | yes | +| engine\_version | The engine version to use | string | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | n/a | yes | +| instance\_class | The instance type of the RDS instance | string | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | n/a | yes | +| port | The port on which the DB accepts connections | string | n/a | yes | +| username | Username for the master DB user | string | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | string | `"false"` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | string | `"false"` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | string | `"true"` | no | +| availability\_zone | The Availability Zone of the RDS instance | string | `""` | no | +| backup\_retention\_period | The days to retain backups for | string | `"7"` | no | +| character\_set\_name | \(Optional\) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | string | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot \(if final\_snapshot\_identifier is specified\) | string | `"false"` | no | +| create\_db\_instance | Whether to create a database instance | string | `"true"` | no | +| create\_db\_option\_group | Whether to create a database option group | string | `"true"` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | string | `"true"` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | string | `"true"` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | string | `"false"` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | string | `"false"` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values \(depending on engine\): alert, audit, error, general, listener, slowquery, trace, postgresql \(PostgreSQL\), upgrade \(PostgreSQL\). | list | `[]` | no | +| family | The family of the DB parameter group | string | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | `"false"` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management \(IAM\) accounts to database accounts is enabled | string | `"false"` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | string | `"0"` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | string | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | string | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | string | `"0"` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | string | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | string | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | string | `"false"` | no | +| name | The DB schema name to create. If omitted, no database is created initially | string | `""` | no | +| option\_group\_description | The description of the option group | string | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | string | `""` | no | +| options | A list of Options to apply. | list | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | string | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | string | `""` | no | +| parameters | A list of DB parameters \(map\) to apply | list | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | string | `"false"` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | string | `"false"` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | string | `"false"` | no | +| storage\_type | One of 'standard' \(magnetic\), 'gp2' \(general purpose SSD\), or 'io1' \(provisioned IOPS SSD\). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | string | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | list | `[]` | no | +| tags | A mapping of tags to assign to all resources | map | `{}` | no | +| timeouts | \(Optional\) Updated Terraform resource management timeouts. Applies to `aws\_db\_instance` in particular to permit resource management times | map | `{ "create": "40m", "delete": "40m", "update": "80m" }` | no | +| timezone | \(Optional\) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | string | `"true"` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | string | `"true"` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | string | `"true"` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | list | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance \(to be used in a Route 53 Alias record\) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password \(this password may be old, because Terraform doesn't track it after initial creation\) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.8.0-rc.1.md b/tests/output/replace/default/TEST-0.8.0-rc.1.md new file mode 100644 index 0000000..e912587 --- /dev/null +++ b/tests/output/replace/default/TEST-0.8.0-rc.1.md @@ -0,0 +1,97 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | +| engine | The database engine to use | `any` | n/a | yes | +| engine\_version | The engine version to use | `any` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `any` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | +| port | The port on which the DB accepts connections | `any` | n/a | yes | +| username | Username for the master DB user | `any` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `7` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | +| tags | A mapping of tags to assign to all resources | `map` | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws\_db\_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
 | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.8.0-rc.2.md b/tests/output/replace/default/TEST-0.8.0-rc.2.md new file mode 100644 index 0000000..78db06b --- /dev/null +++ b/tests/output/replace/default/TEST-0.8.0-rc.2.md @@ -0,0 +1,97 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | +| engine | The database engine to use | `any` | n/a | yes | +| engine\_version | The engine version to use | `any` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `any` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | +| port | The port on which the DB accepts connections | `any` | n/a | yes | +| username | Username for the master DB user | `any` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `7` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | +| tags | A mapping of tags to assign to all resources | `map` | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
 | no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.8.0-rc.3.md b/tests/output/replace/default/TEST-0.8.0-rc.3.md new file mode 100644 index 0000000..ed85e52 --- /dev/null +++ b/tests/output/replace/default/TEST-0.8.0-rc.3.md @@ -0,0 +1,97 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | +| engine | The database engine to use | `any` | n/a | yes | +| engine\_version | The engine version to use | `any` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `any` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | +| port | The port on which the DB accepts connections | `any` | n/a | yes | +| username | Username for the master DB user | `any` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `7` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | +| tags | A mapping of tags to assign to all resources | `map` | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.8.0.md b/tests/output/replace/default/TEST-0.8.0.md new file mode 100644 index 0000000..ed85e52 --- /dev/null +++ b/tests/output/replace/default/TEST-0.8.0.md @@ -0,0 +1,97 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | +| engine | The database engine to use | `any` | n/a | yes | +| engine\_version | The engine version to use | `any` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `any` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | +| port | The port on which the DB accepts connections | `any` | n/a | yes | +| username | Username for the master DB user | `any` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `7` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | +| tags | A mapping of tags to assign to all resources | `map` | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/output/replace/default/TEST-0.8.1.md b/tests/output/replace/default/TEST-0.8.1.md new file mode 100644 index 0000000..ed85e52 --- /dev/null +++ b/tests/output/replace/default/TEST-0.8.1.md @@ -0,0 +1,97 @@ +# Test + +Stuff before terraform-docs + + +## Providers + +No provider. + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:-----:| +| allocated\_storage | The allocated storage in gigabytes | `any` | n/a | yes | +| backup\_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance\_window | `any` | n/a | yes | +| engine | The database engine to use | `any` | n/a | yes | +| engine\_version | The engine version to use | `any` | n/a | yes | +| identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | `any` | n/a | yes | +| instance\_class | The instance type of the RDS instance | `any` | n/a | yes | +| maintenance\_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | `any` | n/a | yes | +| password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | `any` | n/a | yes | +| port | The port on which the DB accepts connections | `any` | n/a | yes | +| username | Username for the master DB user | `any` | n/a | yes | +| allow\_major\_version\_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | `bool` | `false` | no | +| apply\_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | `bool` | `false` | no | +| auto\_minor\_version\_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | `bool` | `true` | no | +| availability\_zone | The Availability Zone of the RDS instance | `string` | `""` | no | +| backup\_retention\_period | The days to retain backups for | `number` | `7` | no | +| character\_set\_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS for more information | `string` | `""` | no | +| copy\_tags\_to\_snapshot | On delete, copy all Instance tags to the final snapshot (if final\_snapshot\_identifier is specified) | `bool` | `false` | no | +| create\_db\_instance | Whether to create a database instance | `bool` | `true` | no | +| create\_db\_option\_group | Whether to create a database option group | `bool` | `true` | no | +| create\_db\_parameter\_group | Whether to create a database parameter group | `bool` | `true` | no | +| create\_db\_subnet\_group | Whether to create a database subnet group | `bool` | `true` | no | +| create\_monitoring\_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | `bool` | `false` | no | +| db\_subnet\_group\_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | `string` | `""` | no | +| deletion\_protection | The database can't be deleted when this value is set to true. | `bool` | `false` | no | +| enabled\_cloudwatch\_logs\_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | `list` | `[]` | no | +| family | The family of the DB parameter group | `string` | `""` | no | +| final\_snapshot\_identifier | The name of your final DB snapshot when this DB instance is deleted. | `bool` | `false` | no | +| iam\_database\_authentication\_enabled | Specifies whether or mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled | `bool` | `false` | no | +| iops | The amount of provisioned IOPS. Setting this implies a storage\_type of 'io1' | `number` | `0` | no | +| kms\_key\_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage\_encrypted is set to true and kms\_key\_id is not specified the default KMS key created in your account will be used | `string` | `""` | no | +| license\_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | `string` | `""` | no | +| major\_engine\_version | Specifies the major version of the engine that this option group should be associated with | `string` | `""` | no | +| monitoring\_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | `number` | `0` | no | +| monitoring\_role\_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring\_interval is non-zero. | `string` | `""` | no | +| monitoring\_role\_name | Name of the IAM role which will be created when create\_monitoring\_role is enabled. | `string` | `"rds-monitoring-role"` | no | +| multi\_az | Specifies if the RDS instance is multi-AZ | `bool` | `false` | no | +| name | The DB schema name to create. If omitted, no database is created initially | `string` | `""` | no | +| option\_group\_description | The description of the option group | `string` | `""` | no | +| option\_group\_name | Name of the DB option group to associate. Setting this automatically disables option\_group creation | `string` | `""` | no | +| options | A list of Options to apply. | `list` | `[]` | no | +| parameter\_group\_description | Description of the DB parameter group to create | `string` | `""` | no | +| parameter\_group\_name | Name of the DB parameter group to associate or create | `string` | `""` | no | +| parameters | A list of DB parameters (map) to apply | `list` | `[]` | no | +| publicly\_accessible | Bool to control if instance is publicly accessible | `bool` | `false` | no | +| replicate\_source\_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | `string` | `""` | no | +| skip\_final\_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final\_snapshot\_identifier | `bool` | `false` | no | +| snapshot\_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | `string` | `""` | no | +| storage\_encrypted | Specifies whether the DB instance is encrypted | `bool` | `false` | no | +| storage\_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'standard' if not. Note that this behaviour is different from the AWS web console, where the default is 'gp2'. | `string` | `"gp2"` | no | +| subnet\_ids | A list of VPC subnet IDs | `list` | `[]` | no | +| tags | A mapping of tags to assign to all resources | `map` | `{}` | no | +| timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | `map` | 
{
  "create": "40m",
  "delete": "40m",
  "update": "80m"
}
| no | +| timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | `string` | `""` | no | +| use\_option\_group\_name\_prefix | Whether to use the option group name prefix or not | `bool` | `true` | no | +| use\_parameter\_group\_name\_prefix | Whether to use the parameter group name prefix or not | `bool` | `true` | no | +| use\_subnet\_group\_name\_prefix | Whether to use the subnet group name prefix or not | `bool` | `true` | no | +| vpc\_security\_group\_ids | List of VPC security groups to associate | `list` | `[]` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| this\_db\_instance\_address | The address of the RDS instance | +| this\_db\_instance\_arn | The ARN of the RDS instance | +| this\_db\_instance\_availability\_zone | The availability zone of the RDS instance | +| this\_db\_instance\_endpoint | The connection endpoint | +| this\_db\_instance\_hosted\_zone\_id | The canonical hosted zone ID of the DB instance (to be used in a Route 53 Alias record) | +| this\_db\_instance\_id | The RDS instance ID | +| this\_db\_instance\_name | The database name | +| this\_db\_instance\_password | The database password (this password may be old, because Terraform doesn't track it after initial creation) | +| this\_db\_instance\_port | The database port | +| this\_db\_instance\_resource\_id | The RDS Resource ID of this instance | +| this\_db\_instance\_status | The RDS instance status | +| this\_db\_instance\_username | The master username for the database | +| this\_db\_option\_group\_arn | The ARN of the db option group | +| this\_db\_option\_group\_id | The db option group id | +| this\_db\_parameter\_group\_arn | The ARN of the db parameter group | +| this\_db\_parameter\_group\_id | The db parameter group id | +| this\_db\_subnet\_group\_arn | The ARN of the db subnet group | +| this\_db\_subnet\_group\_id | The db subnet group id | + + + +Stuff after terraform-docs diff --git a/tests/default/TEST-latest.md b/tests/output/replace/default/TEST-latest.md similarity index 100% rename from tests/default/TEST-latest.md rename to tests/output/replace/default/TEST-latest.md diff --git a/tests/output/replace/default/main.tf b/tests/output/replace/default/main.tf new file mode 120000 index 0000000..eac81be --- /dev/null +++ b/tests/output/replace/default/main.tf @@ -0,0 +1 @@ +../../../input/default/main.tf \ No newline at end of file From 09d8cbd1cba41fc17e21b6f5058ecf8047d23e9e Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 1 Feb 2020 19:20:32 +0100 Subject: [PATCH 4/6] Fix terraform-docs directory workings --- Dockerfile-0.11 | 1 - Dockerfile-0.12 | 1 - data/docker-entrypoint-0.11.sh | 26 +++++++++++++------------- data/docker-entrypoint-0.12.sh | 25 +++++++++++++------------ 4 files changed, 26 insertions(+), 27 deletions(-) diff --git a/Dockerfile-0.11 b/Dockerfile-0.11 index 630ad11..a8f6401 100644 --- a/Dockerfile-0.11 +++ b/Dockerfile-0.11 @@ -66,7 +66,6 @@ COPY --from=builder /usr/local/bin/terraform-docs /usr/local/bin/terraform-docs COPY ./data/docker-entrypoint-0.11.sh /docker-entrypoint.sh COPY ./data/terraform-docs.awk /terraform-docs.awk -ENV WORKDIR /data WORKDIR /data CMD ["terraform-docs", "--version"] diff --git a/Dockerfile-0.12 b/Dockerfile-0.12 index 5ff775f..1063610 100644 --- a/Dockerfile-0.12 +++ b/Dockerfile-0.12 @@ -51,7 +51,6 @@ LABEL \ COPY --from=builder /usr/local/bin/terraform-docs /usr/local/bin/terraform-docs COPY ./data/docker-entrypoint-0.12.sh /docker-entrypoint.sh -ENV WORKDIR /data WORKDIR /data CMD ["terraform-docs", "--version"] diff --git a/data/docker-entrypoint-0.11.sh b/data/docker-entrypoint-0.11.sh index f069b0f..840b809 100755 --- a/data/docker-entrypoint-0.11.sh +++ b/data/docker-entrypoint-0.11.sh @@ -79,33 +79,33 @@ if [ "${#}" -ge "1" ]; then # Check if file exists - if [ ! -f "${WORKDIR}/${MY_FILE}" ]; then - >&2 echo "Error, ${MY_FILE} not found in: ${WORKDIR}/${MY_FILE}" + if [ ! -f "${MY_FILE}" ]; then + >&2 echo "Error, File not found in: ${MY_FILE}" exit 1 fi # Check if starting delimiter exists in file - if ! grep -Fq "${DELIM_START}" "${WORKDIR}/${MY_FILE}"; then + if ! grep -Fq "${DELIM_START}" "${MY_FILE}"; then >&2 echo "Error, Starting delimiter not found ${MY_FILE}: '${DELIM_START}'" exit 1 fi # Check if closint delimiter exists in file - if ! grep -Fq "${DELIM_CLOSE}" "${WORKDIR}/${MY_FILE}"; then + if ! grep -Fq "${DELIM_CLOSE}" "${MY_FILE}"; then >&2 echo "Error, Closing delimiter not found ${MY_FILE}: '${DELIM_CLOSE}'" exit 1 fi # Get owner and permissions of current file - UID="$(stat -c %u "${WORKDIR}/${MY_FILE}")" - GID="$(stat -c %g "${WORKDIR}/${MY_FILE}")" - PERM="$(stat -c %a "${WORKDIR}/${MY_FILE}")" + UID="$(stat -c %u "${MY_FILE}")" + GID="$(stat -c %g "${MY_FILE}")" + PERM="$(stat -c %a "${MY_FILE}")" # Terraform < 0.12 if [ "${1}" = "terraform-docs-replace" ]; then # Remove first argument "replace" shift; # Get terraform-docs output - >&2 echo "terraform-docs ${*} ${WORKDIR}" - DOCS="$(terraform-docs "${@}" "${WORKDIR}")" + >&2 echo "terraform-docs ${*} $(dirname "${MY_FILE}")" + DOCS="$(terraform-docs "${@}" "$(dirname "${MY_FILE}")")" # Terraform >= 0.12 else # Remove first argument "replace" @@ -113,7 +113,7 @@ if [ "${#}" -ge "1" ]; then mkdir -p /tmp-012 awk -f /terraform-docs.awk -- *.tf > "/tmp-012/tmp.tf" # Get terraform-docs output - >&2 echo "terraform-docs-012 ${*} ${WORKDIR}" + >&2 echo "terraform-docs-012 ${*} $(dirname "${MY_FILE}")" if ! DOCS="$(terraform-docs "${@}" "/tmp-012")"; then cat -n "/tmp-012/tmp.tf" >&2 exit 1 @@ -122,16 +122,16 @@ if [ "${#}" -ge "1" ]; then # Create temporary README.md mkdir -p /tmp - grep -B 100000000 -F "${DELIM_START}" "${WORKDIR}/${MY_FILE}" > /tmp/README.md + grep -B 100000000 -F "${DELIM_START}" "${MY_FILE}" > /tmp/README.md printf "%s\\n\\n" "${DOCS}" >> /tmp/README.md - grep -A 100000000 -F "${DELIM_CLOSE}" "${WORKDIR}/${MY_FILE}" >> /tmp/README.md + grep -A 100000000 -F "${DELIM_CLOSE}" "${MY_FILE}" >> /tmp/README.md # Adjust permissions of temporary file chown "${UID}:${GID}" /tmp/README.md chmod "${PERM}" /tmp/README.md # Overwrite existing file - mv -f /tmp/README.md "${WORKDIR}/${MY_FILE}" + mv -f /tmp/README.md "${MY_FILE}" exit 0 ### diff --git a/data/docker-entrypoint-0.12.sh b/data/docker-entrypoint-0.12.sh index e8a303f..2de8a43 100755 --- a/data/docker-entrypoint-0.12.sh +++ b/data/docker-entrypoint-0.12.sh @@ -81,44 +81,44 @@ if [ "${#}" -ge "1" ]; then # Check if file exists - if [ ! -f "${WORKDIR}/${MY_FILE}" ]; then - >&2 echo "Error, ${MY_FILE} not found in: ${WORKDIR}/${MY_FILE}" + if [ ! -f "${MY_FILE}" ]; then + >&2 echo "Error, File not found in: ${MY_FILE}" exit 1 fi # Check if starting delimiter exists in file - if ! grep -Fq "${DELIM_START}" "${WORKDIR}/${MY_FILE}"; then + if ! grep -Fq "${DELIM_START}" "${MY_FILE}"; then >&2 echo "Error, Starting delimiter not found ${MY_FILE}: '${DELIM_START}'" exit 1 fi # Check if closint delimiter exists in file - if ! grep -Fq "${DELIM_CLOSE}" "${WORKDIR}/${MY_FILE}"; then + if ! grep -Fq "${DELIM_CLOSE}" "${MY_FILE}"; then >&2 echo "Error, Closing delimiter not found ${MY_FILE}: '${DELIM_CLOSE}'" exit 1 fi # Get owner and permissions of current file - UID="$(stat -c %u "${WORKDIR}/${MY_FILE}")" - GID="$(stat -c %g "${WORKDIR}/${MY_FILE}")" - PERM="$(stat -c %a "${WORKDIR}/${MY_FILE}")" + UID="$(stat -c %u "${MY_FILE}")" + GID="$(stat -c %g "${MY_FILE}")" + PERM="$(stat -c %a "${MY_FILE}")" # Remove first argument "replace" shift; # Get terraform-docs output - >&2 echo "terraform-docs ${*} ${WORKDIR}" - DOCS="$(terraform-docs "${@}" "${WORKDIR}")" + >&2 echo "terraform-docs ${*} $(dirname "${MY_FILE}")" + DOCS="$(terraform-docs "${@}" "$(dirname "${MY_FILE}")")" # Create temporary README.md mkdir -p /tmp - grep -B 100000000 -F "${DELIM_START}" "${WORKDIR}/${MY_FILE}" > /tmp/README.md + grep -B 100000000 -F "${DELIM_START}" "${MY_FILE}" > /tmp/README.md printf "%s\\n\\n" "${DOCS}" >> /tmp/README.md - grep -A 100000000 -F "${DELIM_CLOSE}" "${WORKDIR}/${MY_FILE}" >> /tmp/README.md + grep -A 100000000 -F "${DELIM_CLOSE}" "${MY_FILE}" >> /tmp/README.md # Adjust permissions of temporary file chown "${UID}:${GID}" /tmp/README.md chmod "${PERM}" /tmp/README.md # Overwrite existing file - mv -f /tmp/README.md "${WORKDIR}/${MY_FILE}" + mv -f /tmp/README.md "${MY_FILE}" exit 0 ### @@ -128,6 +128,7 @@ if [ "${#}" -ge "1" ]; then # Remove first argument "replace" shift + >&2 echo "terraform-docs ${*}" terraform-docs "${@}" ### From 2b30f7c346c1741379f1bd60b0ae68ac94342766 Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 1 Feb 2020 19:39:16 +0100 Subject: [PATCH 5/6] Fix pre TF 0.12 generators --- data/docker-entrypoint-0.11.sh | 16 +++++++++++----- tests/output/generate/0.12/TEST-0.1.1.md | 8 -------- tests/output/generate/basic/TEST-0.1.1.md | 2 -- tests/output/generate/default/TEST-0.1.1.md | 8 -------- 4 files changed, 11 insertions(+), 23 deletions(-) diff --git a/data/docker-entrypoint-0.11.sh b/data/docker-entrypoint-0.11.sh index 840b809..6ecaf17 100755 --- a/data/docker-entrypoint-0.11.sh +++ b/data/docker-entrypoint-0.11.sh @@ -111,7 +111,7 @@ if [ "${#}" -ge "1" ]; then # Remove first argument "replace" shift; mkdir -p /tmp-012 - awk -f /terraform-docs.awk -- *.tf > "/tmp-012/tmp.tf" + awk -f /terraform-docs.awk -- "$(dirname "${MY_FILE}")/"*.tf > "/tmp-012/tmp.tf" # Get terraform-docs output >&2 echo "terraform-docs-012 ${*} $(dirname "${MY_FILE}")" if ! DOCS="$(terraform-docs "${@}" "/tmp-012")"; then @@ -141,19 +141,25 @@ if [ "${#}" -ge "1" ]; then # Terraform < 0.12 if [ "${1}" = "terraform-docs" ]; then + >&2 echo "${*}" exec "${@}" # Terraform >= 0.12 else - mkdir -p /tmp-012 - awk -f /terraform-docs.awk -- *.tf > "/tmp-012/tmp.tf" - # Remove last argument (path) + # Store and Remove last argument (filename) + eval MY_DIR="\${$#}" # store last argument args="$(trim_last_arg "${@}")" # get all the args except the last arg eval "set -- ${args}" # update the shell's arguments with the new value - # Remove first argument (terraform-docs-012) + + mkdir -p /tmp-012 + awk -f /terraform-docs.awk -- "${MY_DIR}/"*.tf > "/tmp-012/tmp.tf" + + # Remove first argument shift + # Execute + >&2 echo "terraform-docs ${*} ${MY_DIR}" if ! terraform-docs "${@}" "/tmp-012/"; then cat -n "/tmp-012/tmp.tf" >&2 exit 1 diff --git a/tests/output/generate/0.12/TEST-0.1.1.md b/tests/output/generate/0.12/TEST-0.1.1.md index 1df2a59..5e9c964 100644 --- a/tests/output/generate/0.12/TEST-0.1.1.md +++ b/tests/output/generate/0.12/TEST-0.1.1.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -144,6 +139,3 @@ test | this_security_group_owner_id | The owner ID | | this_security_group_vpc_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/basic/TEST-0.1.1.md b/tests/output/generate/basic/TEST-0.1.1.md index 3de12e8..0bfa926 100644 --- a/tests/output/generate/basic/TEST-0.1.1.md +++ b/tests/output/generate/basic/TEST-0.1.1.md @@ -1,4 +1,3 @@ - ## Inputs @@ -6,4 +5,3 @@ |------|-------------|:----:|:-----:|:-----:| | test | test description | string | - | yes | - diff --git a/tests/output/generate/default/TEST-0.1.1.md b/tests/output/generate/default/TEST-0.1.1.md index 30339e3..862c174 100644 --- a/tests/output/generate/default/TEST-0.1.1.md +++ b/tests/output/generate/default/TEST-0.1.1.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -89,6 +84,3 @@ Stuff before terraform-docs | this_db_subnet_group_arn | The ARN of the db subnet group | | this_db_subnet_group_id | The db subnet group id | - - -Stuff after terraform-docs From 40d6e0fa1ff59255cb061824c5920a9e0d24149a Mon Sep 17 00:00:00 2001 From: cytopia Date: Sat, 1 Feb 2020 19:50:23 +0100 Subject: [PATCH 6/6] Adjust test cases for generate command --- tests/output/generate/0.12/TEST-0.1.0.md | 8 -------- tests/output/generate/0.12/TEST-0.2.0.md | 8 -------- tests/output/generate/0.12/TEST-0.3.0.md | 8 -------- tests/output/generate/0.12/TEST-0.4.0.md | 8 -------- tests/output/generate/0.12/TEST-0.4.5.md | 8 -------- tests/output/generate/0.12/TEST-0.5.0.md | 8 -------- tests/output/generate/0.12/TEST-0.6.0.md | 8 -------- tests/output/generate/0.12/TEST-0.7.0.md | 8 -------- tests/output/generate/0.12/TEST-0.8.0-rc.1.md | 8 -------- tests/output/generate/0.12/TEST-0.8.0-rc.2.md | 8 -------- tests/output/generate/0.12/TEST-0.8.0-rc.3.md | 8 -------- tests/output/generate/0.12/TEST-0.8.0.md | 8 -------- tests/output/generate/0.12/TEST-0.8.1.md | 8 -------- tests/output/generate/basic/TEST-0.1.0.md | 2 -- tests/output/generate/basic/TEST-0.2.0.md | 2 -- tests/output/generate/basic/TEST-0.3.0.md | 2 -- tests/output/generate/basic/TEST-0.4.0.md | 2 -- tests/output/generate/basic/TEST-0.4.5.md | 2 -- tests/output/generate/basic/TEST-0.5.0.md | 2 -- tests/output/generate/basic/TEST-0.6.0.md | 2 -- tests/output/generate/basic/TEST-0.7.0.md | 2 -- tests/output/generate/basic/TEST-0.8.0-rc.1.md | 2 -- tests/output/generate/basic/TEST-0.8.0-rc.2.md | 2 -- tests/output/generate/basic/TEST-0.8.0-rc.3.md | 2 -- tests/output/generate/basic/TEST-0.8.0.md | 2 -- tests/output/generate/basic/TEST-0.8.1.md | 2 -- tests/output/generate/default/TEST-0.1.0.md | 8 -------- tests/output/generate/default/TEST-0.2.0.md | 8 -------- tests/output/generate/default/TEST-0.3.0.md | 8 -------- tests/output/generate/default/TEST-0.4.0.md | 8 -------- tests/output/generate/default/TEST-0.4.5.md | 8 -------- tests/output/generate/default/TEST-0.5.0.md | 8 -------- tests/output/generate/default/TEST-0.6.0.md | 8 -------- tests/output/generate/default/TEST-0.7.0.md | 8 -------- tests/output/generate/default/TEST-0.8.0-rc.1.md | 8 -------- tests/output/generate/default/TEST-0.8.0-rc.2.md | 8 -------- tests/output/generate/default/TEST-0.8.0-rc.3.md | 8 -------- tests/output/generate/default/TEST-0.8.0.md | 8 -------- tests/output/generate/default/TEST-0.8.1.md | 8 -------- 39 files changed, 234 deletions(-) diff --git a/tests/output/generate/0.12/TEST-0.1.0.md b/tests/output/generate/0.12/TEST-0.1.0.md index 46495a8..4fca1f4 100644 --- a/tests/output/generate/0.12/TEST-0.1.0.md +++ b/tests/output/generate/0.12/TEST-0.1.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -144,6 +139,3 @@ test | this_security_group_owner_id | | | this_security_group_vpc_id | | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.2.0.md b/tests/output/generate/0.12/TEST-0.2.0.md index 1df2a59..5e9c964 100644 --- a/tests/output/generate/0.12/TEST-0.2.0.md +++ b/tests/output/generate/0.12/TEST-0.2.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -144,6 +139,3 @@ test | this_security_group_owner_id | The owner ID | | this_security_group_vpc_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.3.0.md b/tests/output/generate/0.12/TEST-0.3.0.md index 86dc477..1f55135 100644 --- a/tests/output/generate/0.12/TEST-0.3.0.md +++ b/tests/output/generate/0.12/TEST-0.3.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -140,6 +135,3 @@ Stuff before terraform-docs | this_security_group_owner_id | The owner ID | | this_security_group_vpc_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.4.0.md b/tests/output/generate/0.12/TEST-0.4.0.md index 6046ae4..5d91dd0 100644 --- a/tests/output/generate/0.12/TEST-0.4.0.md +++ b/tests/output/generate/0.12/TEST-0.4.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -144,6 +139,3 @@ test | this_security_group_owner_id | The owner ID | | this_security_group_vpc_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.4.5.md b/tests/output/generate/0.12/TEST-0.4.5.md index 7223bee..b31ef23 100644 --- a/tests/output/generate/0.12/TEST-0.4.5.md +++ b/tests/output/generate/0.12/TEST-0.4.5.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs | Name | Description | Type | Default | Required | @@ -143,6 +138,3 @@ test | this_security_group_owner_id | The owner ID | | this_security_group_vpc_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.5.0.md b/tests/output/generate/0.12/TEST-0.5.0.md index 47165ed..81e502c 100644 --- a/tests/output/generate/0.12/TEST-0.5.0.md +++ b/tests/output/generate/0.12/TEST-0.5.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs | Name | Description | Type | Default | Required | @@ -143,6 +138,3 @@ test | this\_security\_group\_owner\_id | The owner ID | | this\_security\_group\_vpc\_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.6.0.md b/tests/output/generate/0.12/TEST-0.6.0.md index 92477fd..4cc3754 100644 --- a/tests/output/generate/0.12/TEST-0.6.0.md +++ b/tests/output/generate/0.12/TEST-0.6.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs | Name | Description | Type | Default | Required | @@ -139,6 +134,3 @@ Stuff before terraform-docs | this\_security\_group\_owner\_id | The owner ID | | this\_security\_group\_vpc\_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.7.0.md b/tests/output/generate/0.12/TEST-0.7.0.md index 21108de..f4e2f0c 100644 --- a/tests/output/generate/0.12/TEST-0.7.0.md +++ b/tests/output/generate/0.12/TEST-0.7.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs | Name | Description | Type | Default | Required | @@ -139,6 +134,3 @@ Stuff before terraform-docs | this\_security\_group\_owner\_id | The owner ID | | this\_security\_group\_vpc\_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.8.0-rc.1.md b/tests/output/generate/0.12/TEST-0.8.0-rc.1.md index 1d7d55c..49fcbff 100644 --- a/tests/output/generate/0.12/TEST-0.8.0-rc.1.md +++ b/tests/output/generate/0.12/TEST-0.8.0-rc.1.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -141,6 +136,3 @@ No provider. | this\_security\_group\_owner\_id | The owner ID | | this\_security\_group\_vpc\_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.8.0-rc.2.md b/tests/output/generate/0.12/TEST-0.8.0-rc.2.md index 07fcb39..ff3e2ef 100644 --- a/tests/output/generate/0.12/TEST-0.8.0-rc.2.md +++ b/tests/output/generate/0.12/TEST-0.8.0-rc.2.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -141,6 +136,3 @@ No provider. | this\_security\_group\_owner\_id | The owner ID | | this\_security\_group\_vpc\_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.8.0-rc.3.md b/tests/output/generate/0.12/TEST-0.8.0-rc.3.md index b6d868b..45b9b0e 100644 --- a/tests/output/generate/0.12/TEST-0.8.0-rc.3.md +++ b/tests/output/generate/0.12/TEST-0.8.0-rc.3.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -141,6 +136,3 @@ No provider. | this\_security\_group\_owner\_id | The owner ID | | this\_security\_group\_vpc\_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.8.0.md b/tests/output/generate/0.12/TEST-0.8.0.md index 97d7530..ed80592 100644 --- a/tests/output/generate/0.12/TEST-0.8.0.md +++ b/tests/output/generate/0.12/TEST-0.8.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -141,6 +136,3 @@ No provider. | this\_security\_group\_owner\_id | The owner ID | | this\_security\_group\_vpc\_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/0.12/TEST-0.8.1.md b/tests/output/generate/0.12/TEST-0.8.1.md index 30c429c..691652f 100644 --- a/tests/output/generate/0.12/TEST-0.8.1.md +++ b/tests/output/generate/0.12/TEST-0.8.1.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -141,6 +136,3 @@ No provider. | this\_security\_group\_owner\_id | The owner ID | | this\_security\_group\_vpc\_id | The VPC ID | - - -Stuff after terraform-docs diff --git a/tests/output/generate/basic/TEST-0.1.0.md b/tests/output/generate/basic/TEST-0.1.0.md index 11327b8..0180274 100644 --- a/tests/output/generate/basic/TEST-0.1.0.md +++ b/tests/output/generate/basic/TEST-0.1.0.md @@ -1,4 +1,3 @@ - ## Inputs @@ -6,4 +5,3 @@ |------|-------------|:-----:|:-----:| | test | test description | - | yes | - diff --git a/tests/output/generate/basic/TEST-0.2.0.md b/tests/output/generate/basic/TEST-0.2.0.md index 3de12e8..0bfa926 100644 --- a/tests/output/generate/basic/TEST-0.2.0.md +++ b/tests/output/generate/basic/TEST-0.2.0.md @@ -1,4 +1,3 @@ - ## Inputs @@ -6,4 +5,3 @@ |------|-------------|:----:|:-----:|:-----:| | test | test description | string | - | yes | - diff --git a/tests/output/generate/basic/TEST-0.3.0.md b/tests/output/generate/basic/TEST-0.3.0.md index 3de12e8..0bfa926 100644 --- a/tests/output/generate/basic/TEST-0.3.0.md +++ b/tests/output/generate/basic/TEST-0.3.0.md @@ -1,4 +1,3 @@ - ## Inputs @@ -6,4 +5,3 @@ |------|-------------|:----:|:-----:|:-----:| | test | test description | string | - | yes | - diff --git a/tests/output/generate/basic/TEST-0.4.0.md b/tests/output/generate/basic/TEST-0.4.0.md index 3de12e8..0bfa926 100644 --- a/tests/output/generate/basic/TEST-0.4.0.md +++ b/tests/output/generate/basic/TEST-0.4.0.md @@ -1,4 +1,3 @@ - ## Inputs @@ -6,4 +5,3 @@ |------|-------------|:----:|:-----:|:-----:| | test | test description | string | - | yes | - diff --git a/tests/output/generate/basic/TEST-0.4.5.md b/tests/output/generate/basic/TEST-0.4.5.md index c5b33ef..8d3c5ef 100644 --- a/tests/output/generate/basic/TEST-0.4.5.md +++ b/tests/output/generate/basic/TEST-0.4.5.md @@ -1,8 +1,6 @@ - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| | test | test description | string | - | yes | - diff --git a/tests/output/generate/basic/TEST-0.5.0.md b/tests/output/generate/basic/TEST-0.5.0.md index c5b33ef..8d3c5ef 100644 --- a/tests/output/generate/basic/TEST-0.5.0.md +++ b/tests/output/generate/basic/TEST-0.5.0.md @@ -1,8 +1,6 @@ - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| | test | test description | string | - | yes | - diff --git a/tests/output/generate/basic/TEST-0.6.0.md b/tests/output/generate/basic/TEST-0.6.0.md index ba2bcfc..59a2538 100644 --- a/tests/output/generate/basic/TEST-0.6.0.md +++ b/tests/output/generate/basic/TEST-0.6.0.md @@ -1,8 +1,6 @@ - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| | test | test description | string | n/a | yes | - diff --git a/tests/output/generate/basic/TEST-0.7.0.md b/tests/output/generate/basic/TEST-0.7.0.md index ba2bcfc..59a2538 100644 --- a/tests/output/generate/basic/TEST-0.7.0.md +++ b/tests/output/generate/basic/TEST-0.7.0.md @@ -1,8 +1,6 @@ - ## Inputs | Name | Description | Type | Default | Required | |------|-------------|:----:|:-----:|:-----:| | test | test description | string | n/a | yes | - diff --git a/tests/output/generate/basic/TEST-0.8.0-rc.1.md b/tests/output/generate/basic/TEST-0.8.0-rc.1.md index 0fb6f5d..79aeb0e 100644 --- a/tests/output/generate/basic/TEST-0.8.0-rc.1.md +++ b/tests/output/generate/basic/TEST-0.8.0-rc.1.md @@ -1,4 +1,3 @@ - ## Providers No provider. @@ -13,4 +12,3 @@ No provider. No output. - diff --git a/tests/output/generate/basic/TEST-0.8.0-rc.2.md b/tests/output/generate/basic/TEST-0.8.0-rc.2.md index 0fb6f5d..79aeb0e 100644 --- a/tests/output/generate/basic/TEST-0.8.0-rc.2.md +++ b/tests/output/generate/basic/TEST-0.8.0-rc.2.md @@ -1,4 +1,3 @@ - ## Providers No provider. @@ -13,4 +12,3 @@ No provider. No output. - diff --git a/tests/output/generate/basic/TEST-0.8.0-rc.3.md b/tests/output/generate/basic/TEST-0.8.0-rc.3.md index 0fb6f5d..79aeb0e 100644 --- a/tests/output/generate/basic/TEST-0.8.0-rc.3.md +++ b/tests/output/generate/basic/TEST-0.8.0-rc.3.md @@ -1,4 +1,3 @@ - ## Providers No provider. @@ -13,4 +12,3 @@ No provider. No output. - diff --git a/tests/output/generate/basic/TEST-0.8.0.md b/tests/output/generate/basic/TEST-0.8.0.md index 0fb6f5d..79aeb0e 100644 --- a/tests/output/generate/basic/TEST-0.8.0.md +++ b/tests/output/generate/basic/TEST-0.8.0.md @@ -1,4 +1,3 @@ - ## Providers No provider. @@ -13,4 +12,3 @@ No provider. No output. - diff --git a/tests/output/generate/basic/TEST-0.8.1.md b/tests/output/generate/basic/TEST-0.8.1.md index 0fb6f5d..79aeb0e 100644 --- a/tests/output/generate/basic/TEST-0.8.1.md +++ b/tests/output/generate/basic/TEST-0.8.1.md @@ -1,4 +1,3 @@ - ## Providers No provider. @@ -13,4 +12,3 @@ No provider. No output. - diff --git a/tests/output/generate/default/TEST-0.1.0.md b/tests/output/generate/default/TEST-0.1.0.md index 7e3b6a4..eb868ed 100644 --- a/tests/output/generate/default/TEST-0.1.0.md +++ b/tests/output/generate/default/TEST-0.1.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -89,6 +84,3 @@ Stuff before terraform-docs | this_db_subnet_group_arn | | | this_db_subnet_group_id | | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.2.0.md b/tests/output/generate/default/TEST-0.2.0.md index 30339e3..862c174 100644 --- a/tests/output/generate/default/TEST-0.2.0.md +++ b/tests/output/generate/default/TEST-0.2.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -89,6 +84,3 @@ Stuff before terraform-docs | this_db_subnet_group_arn | The ARN of the db subnet group | | this_db_subnet_group_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.3.0.md b/tests/output/generate/default/TEST-0.3.0.md index 30339e3..862c174 100644 --- a/tests/output/generate/default/TEST-0.3.0.md +++ b/tests/output/generate/default/TEST-0.3.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -89,6 +84,3 @@ Stuff before terraform-docs | this_db_subnet_group_arn | The ARN of the db subnet group | | this_db_subnet_group_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.4.0.md b/tests/output/generate/default/TEST-0.4.0.md index da7bd13..46e13be 100644 --- a/tests/output/generate/default/TEST-0.4.0.md +++ b/tests/output/generate/default/TEST-0.4.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs @@ -89,6 +84,3 @@ Stuff before terraform-docs | this_db_subnet_group_arn | The ARN of the db subnet group | | this_db_subnet_group_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.4.5.md b/tests/output/generate/default/TEST-0.4.5.md index e924173..b496196 100644 --- a/tests/output/generate/default/TEST-0.4.5.md +++ b/tests/output/generate/default/TEST-0.4.5.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs | Name | Description | Type | Default | Required | @@ -88,6 +83,3 @@ Stuff before terraform-docs | this_db_subnet_group_arn | The ARN of the db subnet group | | this_db_subnet_group_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.5.0.md b/tests/output/generate/default/TEST-0.5.0.md index 09fd18f..615e670 100644 --- a/tests/output/generate/default/TEST-0.5.0.md +++ b/tests/output/generate/default/TEST-0.5.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs | Name | Description | Type | Default | Required | @@ -88,6 +83,3 @@ Stuff before terraform-docs | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | | this\_db\_subnet\_group\_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.6.0.md b/tests/output/generate/default/TEST-0.6.0.md index 9f23684..02510b9 100644 --- a/tests/output/generate/default/TEST-0.6.0.md +++ b/tests/output/generate/default/TEST-0.6.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs | Name | Description | Type | Default | Required | @@ -88,6 +83,3 @@ Stuff before terraform-docs | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | | this\_db\_subnet\_group\_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.7.0.md b/tests/output/generate/default/TEST-0.7.0.md index b1c5ccb..f52c1cd 100644 --- a/tests/output/generate/default/TEST-0.7.0.md +++ b/tests/output/generate/default/TEST-0.7.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Inputs | Name | Description | Type | Default | Required | @@ -88,6 +83,3 @@ Stuff before terraform-docs | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | | this\_db\_subnet\_group\_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.8.0-rc.1.md b/tests/output/generate/default/TEST-0.8.0-rc.1.md index e912587..5b10f6e 100644 --- a/tests/output/generate/default/TEST-0.8.0-rc.1.md +++ b/tests/output/generate/default/TEST-0.8.0-rc.1.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -92,6 +87,3 @@ No provider. | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | | this\_db\_subnet\_group\_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.8.0-rc.2.md b/tests/output/generate/default/TEST-0.8.0-rc.2.md index 78db06b..f853f03 100644 --- a/tests/output/generate/default/TEST-0.8.0-rc.2.md +++ b/tests/output/generate/default/TEST-0.8.0-rc.2.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -92,6 +87,3 @@ No provider. | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | | this\_db\_subnet\_group\_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.8.0-rc.3.md b/tests/output/generate/default/TEST-0.8.0-rc.3.md index ed85e52..e7a254b 100644 --- a/tests/output/generate/default/TEST-0.8.0-rc.3.md +++ b/tests/output/generate/default/TEST-0.8.0-rc.3.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -92,6 +87,3 @@ No provider. | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | | this\_db\_subnet\_group\_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.8.0.md b/tests/output/generate/default/TEST-0.8.0.md index ed85e52..e7a254b 100644 --- a/tests/output/generate/default/TEST-0.8.0.md +++ b/tests/output/generate/default/TEST-0.8.0.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -92,6 +87,3 @@ No provider. | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | | this\_db\_subnet\_group\_id | The db subnet group id | - - -Stuff after terraform-docs diff --git a/tests/output/generate/default/TEST-0.8.1.md b/tests/output/generate/default/TEST-0.8.1.md index ed85e52..e7a254b 100644 --- a/tests/output/generate/default/TEST-0.8.1.md +++ b/tests/output/generate/default/TEST-0.8.1.md @@ -1,8 +1,3 @@ -# Test - -Stuff before terraform-docs - - ## Providers No provider. @@ -92,6 +87,3 @@ No provider. | this\_db\_subnet\_group\_arn | The ARN of the db subnet group | | this\_db\_subnet\_group\_id | The db subnet group id | - - -Stuff after terraform-docs