github.com/atsaki/terraform@v0.4.3-0.20150919165407-25bba5967654/website/source/docs/providers/aws/r/elasticache_cluster.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_elasticache_cluster"
     4  sidebar_current: "docs-aws-resource-elasticache-cluster"
     5  description: |-
     6    Provides an ElastiCache Cluster resource.
     7  ---
     8  
     9  # aws\_elasticache\_cluster
    10  
    11  Provides an ElastiCache Cluster resource.
    12  
    13  ## Example Usage
    14  
    15  ```
    16  resource "aws_elasticache_cluster" "bar" {
    17      cluster_id = "cluster-example"
    18      engine = "memcached"
    19      node_type = "cache.m1.small"
    20      port = 11211
    21      num_cache_nodes = 1
    22      parameter_group_name = "default.memcached1.4"
    23  }
    24  ```
    25  
    26  ## Argument Reference
    27  
    28  The following arguments are supported:
    29  
    30  * `cluster_id` – (Required) Group identifier. This parameter is stored as a
    31  lowercase string
    32  
    33  * `engine` – (Required) Name of the cache engine to be used for this cache cluster.
    34   Valid values for this parameter are `memcached` or `redis`
    35  
    36  * `engine_version` – (Optional) Version number of the cache engine to be used.
    37  See [Selecting a Cache Engine and Version](http://docs.aws.amazon.com/AmazonElastiCache/latest/UserGuide/SelectEngine.html)
    38  in the AWS Documentation center for supported versions
    39  
    40  * `maintenance_window` – (Optional) Specifies the weekly time range which maintenance 
    41  on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). 
    42  The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00`
    43  
    44  * `node_type` – (Required) The compute and memory capacity of the nodes. See
    45  [Available Cache Node Types](http://aws.amazon.com/elasticache/details#Available_Cache_Node_Types) for
    46  supported node types
    47  
    48  * `num_cache_nodes` – (Required) The initial number of cache nodes that the
    49  cache cluster will have. For Redis, this value must be 1. For Memcache, this
    50  value must be between 1 and 20
    51  
    52  * `parameter_group_name` – (Required) Name of the parameter group to associate
    53  with this cache cluster
    54  
    55  * `port` – (Required) The port number on which each of the cache nodes will
    56  accept connections. For Memcache the default is 11211, and for Redis the default port is 6379.
    57  
    58  * `subnet_group_name` – (Optional, VPC only) Name of the subnet group to be used
    59  for the cache cluster.
    60  
    61  * `security_group_names` – (Optional, EC2 Classic only) List of security group
    62  names to associate with this cache cluster
    63  
    64  * `security_group_ids` – (Optional, VPC only) One or more VPC security groups associated
    65   with the cache cluster
    66  
    67  * `apply_immediately` - (Optional) Specifies whether any database modifications
    68       are applied immediately, or during the next maintenance window. Default is
    69       `false`. See [Amazon ElastiCache Documentation for more information.][1]
    70       (Available since v0.6.0)
    71  
    72  * `snapshot_arns` – (Optional) A single-element string list containing an 
    73  Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. 
    74  Example: `arn:aws:s3:::my_bucket/snapshot1.rdb`
    75  
    76  * `tags` - (Optional) A mapping of tags to assign to the resource.
    77  
    78  
    79  ## Attributes Reference
    80  
    81  The following attributes are exported:
    82  
    83  * `cache_nodes` - List of node objects including `id`, `address` and `port`.
    84     Referenceable e.g. as `${aws_elasticache_cluster.bar.cache_nodes.0.address}`
    85     
    86  * `configuration_endpoint` - (Memcached only) The configuration endpoint to allow host discovery
    87  
    88  [1]: http://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheCluster.html