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: "Build Status"
    image: "https://travis-ci.org/cloudposse/terraform-aws-elasticache-redis.svg?branch=master"
    url: "https://travis-ci.org/cloudposse/terraform-aws-elasticache-redis"
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-elasticache-redis.svg"
    url: "https://github.com/cloudposse/terraform-aws-elastic-beanstalk-environment/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: |-
  Include this repository as a module in your existing terraform code:

  ```hcl
  // Generate a random string for auth token, no special chars
  resource "random_string" "auth_token" {
    length = 64
    special = false
  }

  module "example_redis" {
    source          = "git::https://github.com/cloudposse/terraform-aws-elasticache-redis.git?ref=master"
    namespace       = "general"
    name            = "redis"
    stage           = "prod"
    zone_id         = "${var.route53_zone_id}"
    security_groups = ["${var.security_group_id}"]

    auth_token                   = "${random_string.auth_token.result}"
    vpc_id                       = "${var.vpc_id}"
    subnets                      = "${var.private_subnets}"
    maintenance_window           = "wed:03:00-wed:04:00"
    cluster_size                 = "2"
    instance_type                = "cache.t2.micro"
    engine_version               = "4.0.10"
    alarm_cpu_threshold_percent  = "${var.cache_alarm_cpu_threshold_percent}"
    alarm_memory_threshold_bytes = "${var.cache_alarm_memory_threshold_bytes}"
    apply_immediately            = "true"
    availability_zones           = "${var.availability_zones}"

    automatic_failover = "false"
  }

  output "auth_token" {
    value = "${random_string.auth_token.result}"
  }
  ```

examples: |-
  Review the [complete example](examples/simple) 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"