Merge pull request #1869 from hashicorp/b-aws-document-elasticache
provider/aws: Document AWS ElastiCache cluster
This commit is contained in:
Clint
commit
91106a8bd8
|
|
@ -59,6 +59,7 @@ func resourceAwsElasticacheCluster() *schema.Resource {
|
|||
"subnet_group_name": &schema.Schema{
|
||||
Type: schema.TypeString,
|
||||
Optional: true,
|
||||
Computed: true,
|
||||
ForceNew: true,
|
||||
},
|
||||
"security_group_names": &schema.Schema{
|
||||
|
|
|
|||
|
|
@ -0,0 +1,76 @@
|
|||
---
|
||||
layout: "aws"
|
||||
page_title: "AWS: aws_subnet"
|
||||
sidebar_current: "docs-aws-resource-elasticache-cluster"
|
||||
description: |-
|
||||
Provides an VPC subnet 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"
|
||||
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` – (Optional) Name of the parameter group to associate
|
||||
with this cache cluster
|
||||
|
||||
* `port` – (Optional) The port number on which each of the cache nodes will
|
||||
accept connections. Default 11211.
|
||||
|
||||
* `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
|
||||
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `cluster_id`
|
||||
* `engine`
|
||||
* `engine_version`
|
||||
* `node_type`
|
||||
* `num_cache_nodes`
|
||||
* `parameter_group_name`
|
||||
* `port`
|
||||
* `subnet_group_name`
|
||||
* `security_group_names`
|
||||
* `security_group_ids`
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
layout: "aws"
|
||||
page_title: "AWS: aws_subnet"
|
||||
sidebar_current: "docs-aws-resource-elasticache-security-group"
|
||||
description: |-
|
||||
Provides an VPC subnet resource.
|
||||
---
|
||||
|
||||
# aws\_elasticache\_security\_<wbr>group
|
||||
|
||||
Provides an ElastiCache Security Group to control access to one or more cache
|
||||
clusters.
|
||||
|
||||
~> **NOTE:** ElastiCache Security Groups are for use only when working with an
|
||||
ElastiCache cluster **outside** of a VPC. If you are using a VPC, see the
|
||||
[ElastiCache Subnet Group resource](elasticache_subnet_group.html).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "aws_security_group" "bar" {
|
||||
name = "security-group"
|
||||
description = "security group"
|
||||
}
|
||||
|
||||
resource "aws_elasticache_security_group" "bar" {
|
||||
name = "elasticache-security-group"
|
||||
description = "elasticache security group"
|
||||
security_group_names = ["${aws_security_group.bar.name}"]
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `description` – (Required) description for the cache security group
|
||||
* `name` – (Required) Name for the cache security group. This value is stored as
|
||||
a lowercase string
|
||||
* `security_group_names` – (Required) List of EC2 security group names to be
|
||||
authorized for ingress to the cache security group
|
||||
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `description`
|
||||
* `name`
|
||||
* `security_group_names`
|
||||
|
|
@ -0,0 +1,59 @@
|
|||
---
|
||||
layout: "aws"
|
||||
page_title: "AWS: aws_subnet"
|
||||
sidebar_current: "docs-aws-resource-elasticache-subnet-group"
|
||||
description: |-
|
||||
Provides an VPC subnet resource.
|
||||
---
|
||||
|
||||
# aws\_elasticache\_subnet\_group
|
||||
|
||||
Provides an ElastiCache Subnet Group resource.
|
||||
|
||||
~> **NOTE:** ElastiCache Subnet Groups are only for use when working with an
|
||||
ElastiCache cluster **inside** of a VPC. If you are on EC2 Classic, see the
|
||||
[ElastiCache Security Group resource](elasticache_security_group.html).
|
||||
|
||||
## Example Usage
|
||||
|
||||
```
|
||||
resource "aws_vpc" "foo" {
|
||||
cidr_block = "10.0.0.0/16"
|
||||
tags {
|
||||
Name = "tf-test"
|
||||
}
|
||||
}
|
||||
|
||||
resource "aws_subnet" "foo" {
|
||||
vpc_id = "${aws_vpc.foo.id}"
|
||||
cidr_block = "10.0.0.0/24"
|
||||
availability_zone = "us-west-2a"
|
||||
tags {
|
||||
Name = "tf-test"
|
||||
}
|
||||
}
|
||||
|
||||
resource "aws_elasticache_subnet_group" "bar" {
|
||||
name = "tf-test-cache-subnet"
|
||||
description = "tf-test-cache-subnet-group-descr"
|
||||
subnet_ids = ["${aws_subnet.foo.id}"]
|
||||
}
|
||||
```
|
||||
|
||||
## Argument Reference
|
||||
|
||||
The following arguments are supported:
|
||||
|
||||
* `description` – (Required) Description for the cache subnet group
|
||||
* `name` – (Required) Name for the cache subnet group. This value is stored as
|
||||
a lowercase string
|
||||
* `subnet_ids` – (Optional) List of VPC Subnet IDs for the cache subnet group
|
||||
|
||||
## Attributes Reference
|
||||
|
||||
The following attributes are exported:
|
||||
|
||||
* `description`
|
||||
* `name`
|
||||
* `subnet_ids`
|
||||
|
||||
|
|
@ -45,6 +45,18 @@
|
|||
<a href="/docs/providers/aws/r/eip.html">aws_eip</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-aws-resource-elasticache-cluster") %>>
|
||||
<a href="/docs/providers/aws/r/elasticache_cluster.html">aws_elasticache_cluster</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-aws-resource-elasticache-security-group") %>>
|
||||
<a href="/docs/providers/aws/r/elasticache_security_group.html">aws_elasticache_security_group</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-aws-resource-elasticache-subnet-group") %>>
|
||||
<a href="/docs/providers/aws/r/elasticache_subnet_group.html">aws_elasticache_subnet_group</a>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current("docs-aws-resource-elb") %>>
|
||||
<a href="/docs/providers/aws/r/elb.html">aws_elb</a>
|
||||
</li>
|
||||
|
|
|
|||
Loading…
Reference in New Issue