Skip to content

Commit

Permalink
Fix all readmes (#16)
Browse files Browse the repository at this point in the history
* adds readme to cognito module

* fix spelling and descriptions in all readmes

* document all module in main readme
  • Loading branch information
swiknaba authored Jul 13, 2021
1 parent 0cd6e56 commit 85efae0
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 7 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.



Expand Down
22 changes: 22 additions & 0 deletions cognito/README.md
Original file line number Diff line number Diff line change
@@ -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`
2 changes: 1 addition & 1 deletion ecr/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Terraform Module: ECR Repository

A reopsitory for storing built docker images
A reopsitory for storing built docker images.


## Usage
Expand Down
4 changes: 2 additions & 2 deletions kms-key/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 85efae0

Please sign in to comment.