terraform/website/source/docs/providers/aws/r/elasticache_cluster.html.ma...

78 lines
2.7 KiB
Markdown
Raw Normal View History

---
layout: "aws"
page_title: "AWS: aws_elasticache_cluster"
sidebar_current: "docs-aws-resource-elasticache-cluster"
description: |-
Provides an ElastiCache Cluster resource.
---
# aws\_elasticache\_cluster
Provides an ElastiCache Cluster resource.
## Example Usage
```
resource "aws_elasticache_cluster" "bar" {
cluster_id = "cluster-example"
engine = "memcached"
node_type = "cache.m1.small"
2015-06-01 16:55:07 +02:00
port = 11211
num_cache_nodes = 1
parameter_group_name = "default.memcached1.4"
}
```
## Argument Reference
The following arguments are supported:
* `cluster_id` (Required) Group identifier. This parameter is stored as a
lowercase string
* `engine` (Required) Name of the cache engine to be used for this cache cluster.
Valid values for this parameter are `memcached` or `redis`
* `engine_version` (Optional) Version number of the cache engine to be used.
See [Selecting a Cache Engine and Version](http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SelectEngine.html)
in the AWS Documentation center for supported versions
* `node_type` (Required) The compute and memory capacity of the nodes. See
[Available Cache Node Types](http://aws.amazon.com/elasticache/details#Available_Cache_Node_Types) for
supported node types
* `num_cache_nodes` (Required) The initial number of cache nodes that the
cache cluster will have. For Redis, this value must be 1. For Memcache, this
value must be between 1 and 20
* `parameter_group_name` (Required) Name of the parameter group to associate
with this cache cluster
2015-06-01 16:55:07 +02:00
* `port` (Required) The port number on which each of the cache nodes will
accept connections. For Memcache the default is 11211, and for Redis the default port is 6379.
* `subnet_group_name` (Optional, VPC only) Name of the subnet group to be used
for the cache cluster.
* `security_group_names` (Optional, EC2 Classic only) List of security group
names to associate with this cache cluster
* `security_group_ids` (Optional, VPC only) One or more VPC security groups associated
with the cache cluster
* `apply_immediately` - (Optional) Specifies whether any database modifications
are applied immediately, or during the next maintenance window. Default is
`false`. See [Amazon ElastiCache Documentation for more information.][1]
2015-06-02 00:05:07 +02:00
* `tags` - (Optional) A mapping of tags to assign to the resource.
## Attributes Reference
The following attributes are exported:
* `cache_nodes` - List of node objects including `id`, `address` and `port`.
Referenceable e.g. as `${aws_elasticache_cluster.bar.cache_nodes.0.address}`
[1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheCluster.html