Skip to content

T
terraform-aws-rds
Commit e7ff6bd7 authored by Bryant Biggs's avatar Bryant Biggs Committed by GitHub
Browse files
Options

chore: update README.md documentation (#300)

parent cec8528c
Hide whitespace changes
Inline Side-by-side
Showing with 21 additions and 40 deletions
README.md
View file @ e7ff6bd7
...@@ -4,23 +4,17 @@ Terraform module which creates RDS resources on AWS. ...@@ -4,23 +4,17 @@ Terraform module which creates RDS resources on AWS.
These types of resources are supported: These types of resources are supported:
* [DB Instance](https://www.terraform.io/docs/providers/aws/r/db_instance.html) - [DB Instance](https://www.terraform.io/docs/providers/aws/r/db_instance.html)
* [DB Subnet Group](https://www.terraform.io/docs/providers/aws/r/db_subnet_group.html) - [DB Subnet Group](https://www.terraform.io/docs/providers/aws/r/db_subnet_group.html)
* [DB Parameter Group](https://www.terraform.io/docs/providers/aws/r/db_parameter_group.html) - [DB Parameter Group](https://www.terraform.io/docs/providers/aws/r/db_parameter_group.html)
* [DB Option Group](https://www.terraform.io/docs/providers/aws/r/db_option_group.html) - [DB Option Group](https://www.terraform.io/docs/providers/aws/r/db_option_group.html)
Root module calls these modules which can also be used separately to create independent resources: Root module calls these modules which can also be used separately to create independent resources:
* [db_instance](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_instance) - creates RDS DB instance - [db_instance](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_instance) - creates RDS DB instance
* [db_subnet_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_subnet_group) - creates RDS DB subnet group - [db_subnet_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_subnet_group) - creates RDS DB subnet group
* [db_parameter_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_parameter_group) - creates RDS DB parameter group - [db_parameter_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_parameter_group) - creates RDS DB parameter group
* [db_option_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_option_group) - creates RDS DB option group - [db_option_group](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/modules/db_option_group) - creates RDS DB option group
## Terraform versions
Terraform 0.12 and newer. Pin module version to `~> v2.0`. Submit pull-requests to `master` branch.
Terraform 0.11. Pin module version to `~> v1.0`. Submit pull-requests to `terraform011` branch.
## Usage ## Usage
...@@ -122,13 +116,14 @@ module "db" { ...@@ -122,13 +116,14 @@ module "db" {
## Examples ## Examples
* [Complete RDS example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-mysql) - [Complete RDS example for MSSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-mssql)
* [Complete RDS example for PostgreSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-postgres) - [Complete RDS example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-mysql)
* [Complete RDS example for Oracle](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-oracle) - [Complete RDS example for Oracle](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-oracle)
* [Complete RDS example for MSSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-mssql) - [Complete RDS example for PostgreSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/complete-postgres)
* [Enhanced monitoring example](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/enhanced-monitoring) - [Enhanced monitoring example](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/enhanced-monitoring)
* [Replica RDS example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/replica-mysql) - [Replica RDS example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/replica-mysql)
* [Replica RDS example for PostgreSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/replica-postgres) - [Replica RDS example for PostgreSQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/replica-postgres)
- [S3 import example for MySQL](https://github.com/terraform-aws-modules/terraform-aws-rds/tree/master/examples/s3-import-mysql)
## Notes ## Notes
......
examples/complete-mssql/README.md
View file @ e7ff6bd7
# Complete RDS example for MSSQL Server # Complete RDS example for MSSQL Server
Configuration in this directory creates set of RDS resources including DB instance, DB subnet group and DB parameter group. Configuration in this directory creates a set of RDS resources including DB instance, DB subnet group and DB parameter group.
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
## Usage ## Usage
......
examples/complete-mysql/README.md
View file @ e7ff6bd7
# Complete RDS example for MySQL # Complete RDS example for MySQL
Configuration in this directory creates set of RDS resources including DB instance, DB subnet group and DB parameter group. Configuration in this directory creates a set of RDS resources including DB instance, DB subnet group and DB parameter group.
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
## Usage ## Usage
......
examples/complete-oracle/README.md
View file @ e7ff6bd7
# Complete RDS example for Oracle # Complete RDS example for Oracle
Configuration in this directory creates set of RDS resources including DB instance, DB subnet group and DB parameter group. Configuration in this directory creates a set of RDS resources including DB instance, DB subnet group and DB parameter group.
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
## Usage ## Usage
......
examples/complete-postgres/README.md
View file @ e7ff6bd7
# Complete RDS example for PostgreSQL # Complete RDS example for PostgreSQL
Configuration in this directory creates set of RDS resources including DB instance, DB subnet group and DB parameter group. Configuration in this directory creates a set of RDS resources including DB instance, DB subnet group and DB parameter group.
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
## Usage ## Usage
......
examples/enhanced-monitoring/README.md
View file @ e7ff6bd7
...@@ -4,8 +4,6 @@ Configuration in this directory creates the additional resources required to use ...@@ -4,8 +4,6 @@ Configuration in this directory creates the additional resources required to use
See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html for details. See http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html for details.
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
## Usage ## Usage
To run this example you need to execute: To run this example you need to execute:
......
examples/replica-mysql/README.md
View file @ e7ff6bd7
...@@ -2,8 +2,6 @@ ...@@ -2,8 +2,6 @@
Configuration in this directory creates set of RDS resources demonstrating master and replica in the same VPC. Configuration in this directory creates set of RDS resources demonstrating master and replica in the same VPC.
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
## Usage ## Usage
To run this example you need to execute: To run this example you need to execute:
......
examples/replica-postgres/README.md
View file @ e7ff6bd7
...@@ -2,8 +2,6 @@ ...@@ -2,8 +2,6 @@
Configuration in this directory creates set of RDS resources demonstrating master and replica in the same VPC. Configuration in this directory creates set of RDS resources demonstrating master and replica in the same VPC.
Data sources are used to discover existing VPC resources (VPC, subnet and security group).
## Usage ## Usage
To run this example you need to execute: To run this example you need to execute:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment