Skip to content

Commit e7ff6bd

Browse files
bryantbiggsbryantbiggs
authored
chore: update README.md documentation (#300)
1 parent cec8528 commit e7ff6bd

File tree

8 files changed

+21
-40
lines changed

8 files changed

+21
-40
lines changed

‎README.md‎

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,17 @@ Terraform module which creates RDS resources on AWS.
44

55
These types of resources are supported:
66

7-
* [DB Instance](https://www.terraform.io/docs/providers/aws/r/db_instance.html)
8-
* [DB Subnet Group](https://www.terraform.io/docs/providers/aws/r/db_subnet_group.html)
9-
* [DB Parameter Group](https://www.terraform.io/docs/providers/aws/r/db_parameter_group.html)
10-
* [DB Option Group](https://www.terraform.io/docs/providers/aws/r/db_option_group.html)
7+
- [DB Instance](https://www.terraform.io/docs/providers/aws/r/db_instance.html)
8+
- [DB Subnet Group](https://www.terraform.io/docs/providers/aws/r/db_subnet_group.html)
9+
- [DB Parameter Group](https://www.terraform.io/docs/providers/aws/r/db_parameter_group.html)
10+
- [DB Option Group](https://www.terraform.io/docs/providers/aws/r/db_option_group.html)
1111

12-
Root module calls these modules which can also be used separately to create independent resources:
12+
Root module calls these modules which can also be used separately to create independent resources:
1313

14-
* [db_instance](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_instance) - creates RDS DB instance
15-
* [db_subnet_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_subnet_group) - creates RDS DB subnet group
16-
* [db_parameter_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_parameter_group) - creates RDS DB parameter group
17-
* [db_option_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_option_group) - creates RDS DB option group
18-
19-
## Terraform versions
20-
21-
Terraform 0.12 and newer. Pin module version to `~> v2.0`. Submit pull-requests to `master` branch.
22-
23-
Terraform 0.11. Pin module version to `~> v1.0`. Submit pull-requests to `terraform011` branch.
14+
- [db_instance](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_instance) - creates RDS DB instance
15+
- [db_subnet_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_subnet_group) - creates RDS DB subnet group
16+
- [db_parameter_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_parameter_group) - creates RDS DB parameter group
17+
- [db_option_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_option_group) - creates RDS DB option group
2418

2519
## Usage
2620

@@ -122,13 +116,14 @@ module "db" {
122116

123117
## Examples
124118

125-
* [Complete RDS example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-mysql)
126-
* [Complete RDS example for PostgreSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-postgres)
127-
* [Complete RDS example for Oracle](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-oracle)
128-
* [Complete RDS example for MSSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-mssql)
129-
* [Enhanced monitoring example](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/enhanced-monitoring)
130-
* [Replica RDS example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/replica-mysql)
131-
* [Replica RDS example for PostgreSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/replica-postgres)
119+
- [Complete RDS example for MSSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-mssql)
120+
- [Complete RDS example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-mysql)
121+
- [Complete RDS example for Oracle](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-oracle)
122+
- [Complete RDS example for PostgreSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-postgres)
123+
- [Enhanced monitoring example](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/enhanced-monitoring)
124+
- [Replica RDS example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/replica-mysql)
125+
- [Replica RDS example for PostgreSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/replica-postgres)
126+
- [S3 import example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/s3-import-mysql)
132127

133128
## Notes
134129

‎examples/complete-mssql/README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Complete RDS example for MSSQL Server
22

3-
Configuration in this directory creates set of RDS resources including DB instance, DB subnet group and DB parameter group.
4-
5-
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
3+
Configuration in this directory creates a set of RDS resources including DB instance, DB subnet group and DB parameter group.
64

75
## Usage
86

‎examples/complete-mysql/README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Complete RDS example for MySQL
22

3-
Configuration in this directory creates set of RDS resources including DB instance, DB subnet group and DB parameter group.
4-
5-
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
3+
Configuration in this directory creates a set of RDS resources including DB instance, DB subnet group and DB parameter group.
64

75
## Usage
86

‎examples/complete-oracle/README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Complete RDS example for Oracle
22

3-
Configuration in this directory creates set of RDS resources including DB instance, DB subnet group and DB parameter group.
4-
5-
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
3+
Configuration in this directory creates a set of RDS resources including DB instance, DB subnet group and DB parameter group.
64

75
## Usage
86

‎examples/complete-postgres/README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Complete RDS example for PostgreSQL
22

3-
Configuration in this directory creates set of RDS resources including DB instance, DB subnet group and DB parameter group.
4-
5-
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
3+
Configuration in this directory creates a set of RDS resources including DB instance, DB subnet group and DB parameter group.
64

75
## Usage
86

‎examples/enhanced-monitoring/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ Configuration in this directory creates the additional resources required to use
44

55
See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html for details.
66

7-
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
8-
97
## Usage
108

119
To run this example you need to execute:

‎examples/replica-mysql/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Configuration in this directory creates set of RDS resources demonstrating master and replica in the same VPC.
44

5-
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
6-
75
## Usage
86

97
To run this example you need to execute:

‎examples/replica-postgres/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Configuration in this directory creates set of RDS resources demonstrating master and replica in the same VPC.
44

5-
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
6-
75
## Usage
86

97
To run this example you need to execute:

0 commit comments

Comments
 (0)