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-memcached
# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - databases
  - memcached
  - elasticache
# 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-memcached
# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-elasticache-memcached.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-elasticache-memcached/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-elasticache-memcached.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-elasticache-memcached/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-aws-elasticache-redis"
    description: "Terraform module to provision an ElastiCache Redis Cluster"
    url: "https://github.com/cloudposse/terraform-aws-elasticache-redis"
  - name: "terraform-aws-elasticache-cloudwatch-sns-alarms"
    description: "Terraform module that configures CloudWatch SNS alerts for ElastiCache"
    url: "https://github.com/cloudposse/terraform-aws-elasticache-cloudwatch-sns-alarms"
# Short description of this project
description: |-
  Terraform module to provision an [`ElastiCache`](https://aws.amazon.com/elasticache/) Memcached Cluster
# How to use this project
usage: |2-

  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 "this" {
      source  = "cloudposse/label/null"
      # Cloud Posse recommends pinning every module to a specific version
      # version = "x.x.x"
      namespace  = var.namespace
      stage      = var.stage
      name       = var.name
    }

    module "vpc" {
      source = "cloudposse/vpc/aws"
      # Cloud Posse recommends pinning every module to a specific version
      # version = "x.x.x"

      cidr_block = "172.16.0.0/16"

      context = module.this.context
    }

    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
      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

      context = module.this.context
    }

    module "memcached" {
      source = "cloudposse/elasticache-memcached/aws"
      # Cloud Posse recommends pinning every module to a specific version
      # version = "x.x.x"

      availability_zones      = var.availability_zones
      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
      engine_version          = var.engine_version
      apply_immediately       = true
      zone_id                 = var.zone_id

      elasticache_parameter_group_family = var.elasticache_parameter_group_family

      context = module.this.context
    }
  ```
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: []