diff --git a/README.md b/README.md index dba455a5..ec5bf396 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,16 @@ We create modules here for re-use between projects. ## Modules -- [cognito](cognito/README.md) - Create user pools for use with authentication +- [cdn](cdn/README.md) - All ressources required to host a simple CDN. +- [certificate](certificate/README.md) - Requests a certificate from the Amazon Certificate Manager. +- [cognito](cognito/README.md) - Create user pools for use with authentication. +- [ecr](ecr/README.md) - A reopsitory for storing built docker images. - [ecs](ecs/README.md) - Compute cluster for running docker containers -- [kms-key](kms-key/README.md) - Encryption keys for securing various AWS resources -- [rds](rds/README.md) - Postgresql database managed by AWS -- [vpc](vpc/README.md) - Virtual Private Cloud network to contain all resources for a project/environment +- [kms-key](kms-key/README.md) - Encryption keys for securing various AWS resources. +- [nat](nat/README.md) - A reopsitory for setting up a network address translation (NAT). +- [rds](rds/README.md) - Used for creating and configuring databases and their networking. +- [secrets](secrets/README.md) - Used for creating a new secret. +- [vpc](vpc/README.md) - Creates a VPC in AWS account. Also generates a group fo public and private submodules. diff --git a/cognito/README.md b/cognito/README.md new file mode 100644 index 00000000..b86be281 --- /dev/null +++ b/cognito/README.md @@ -0,0 +1,22 @@ +# Terraform Module: Cognito + +Create user pools for use with authentication. + +## Usage + +```terraform +module "ssl-certificate" { + source = "github.com/dbl-works/terraform//certificate?ref=v2021.07.05" + + project = local.project + environment = local.environment + region = local.region + ses_from_email = "TODO" + ses_arn = "TODO" +} +``` + +## Outputs +- `aws_cognito_identity_pool_id` +- `aws_cognito_identity_pool_arn` +- `aws_exports_content` diff --git a/ecr/README.md b/ecr/README.md index 76b57d1a..2ca7eaa3 100644 --- a/ecr/README.md +++ b/ecr/README.md @@ -1,6 +1,6 @@ # Terraform Module: ECR Repository -A reopsitory for storing built docker images +A reopsitory for storing built docker images. ## Usage diff --git a/kms-key/README.md b/kms-key/README.md index b56e12cc..a8389101 100644 --- a/kms-key/README.md +++ b/kms-key/README.md @@ -1,6 +1,6 @@ -# Terraform Module: VPC +# Terraform Module: kms-key -Creates a VPC in AWS account. Also generates a group fo public and private submodules. +Encryption keys for securing various AWS resources. ## Usage