README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-elasticache-redis

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - databases
  - redis
  - elasticache
  - cache

# Categories of this project
categories:
  - terraform-modules/databases

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-elasticache-redis

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-elasticache-redis.svg"
    url: "https://github.com/cloudposse/terraform-aws-elasticache-redis/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

# Short description of this project
description: |-
  Terraform module to provision an [`ElastiCache`](https://aws.amazon.com/elasticache/) Redis Cluster

# How to use this project
usage: |-

  For a complete example, see [examples/complete](examples/complete).

  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).

  ```hcl
    provider "aws" {
      region = var.region
    }

    module "vpc" {
      source = "cloudposse/vpc/aws"
      # Cloud Posse recommends pinning every module to a specific version
      # version = "x.x.x"
      namespace  = var.namespace
      stage      = var.stage
      name       = var.name
      cidr_block = "172.16.0.0/16"
    }

    module "subnets" {
      source = "cloudposse/dynamic-subnets/aws"
      # Cloud Posse recommends pinning every module to a specific version
      # version = "x.x.x"
      availability_zones   = var.availability_zones
      namespace            = var.namespace
      stage                = var.stage
      name                 = var.name
      vpc_id               = module.vpc.vpc_id
      igw_id               = module.vpc.igw_id
      cidr_block           = module.vpc.vpc_cidr_block
      nat_gateway_enabled  = true
      nat_instance_enabled = false
    }

    module "redis" {
      source = "cloudposse/elasticache-redis/aws"
      # Cloud Posse recommends pinning every module to a specific version
      # version = "x.x.x"
      availability_zones         = var.availability_zones
      namespace                  = var.namespace
      stage                      = var.stage
      name                       = var.name
      zone_id                    = var.zone_id
      vpc_id                     = module.vpc.vpc_id
      allowed_security_groups    = [module.vpc.vpc_default_security_group_id]
      subnets                    = module.subnets.private_subnet_ids
      cluster_size               = var.cluster_size
      instance_type              = var.instance_type
      apply_immediately          = true
      automatic_failover_enabled = false
      engine_version             = var.engine_version
      family                     = var.family
      at_rest_encryption_enabled = var.at_rest_encryption_enabled
      transit_encryption_enabled = var.transit_encryption_enabled

      parameter = [
        {
          name  = "notify-keyspace-events"
          value = "lK"
        }
      ]
    }
  ```

examples: |-
  Review the [complete example](examples/complete) to see how to use this module.

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: "Erik Osterman"
    github: "osterman"
  - name: "Igor Rodionov"
    github: "goruha"
  - name: "Andriy Knysh"
    github: "aknysh"
  - name: "Daren Desjardins"
    github: "darend"
  - name: "Max Moon"
    github: "MoonMoon1919"
  - name: "Christopher Riley"
    github: "christopherriley"