ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

provider/aws: Updating the Elastic MapReduce Cluster Instance Group Docs (#13286) 

* Updating the AWS EMR Instance Group docs to fix #13272

* Required -> Optional
This commit is contained in:
Tom Harvey 2017-04-04 08:27:56 +01:00 committed by Paul Stack
parent e3d4c237a9
commit 3ec16e7aeb
1 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
website/source/docs/providers/aws/r/emr_instance_group.html.md
View File

@ -8,9 +8,8 @@ description: |-
# aws\_emr\_instance\_group
Provides an Elastic MapReduce Cluster Instance Group configuration.
See [Amazon Elastic MapReduce Documentation](http://docs.aws.amazon.com/en_en/ElasticMapReduce/latest/ManagementGuide/InstanceGroups.html)
for more information.
Provides an Elastic MapReduce Cluster Instance Group configuration.
See [Amazon Elastic MapReduce Documentation](https://aws.amazon.com/documentation/emr/) for more information.
~> **NOTE:** At this time, Instance Groups cannot be destroyed through the API nor
web interface. Instance Groups are destroyed when the EMR Cluster is destroyed.
@ -19,7 +18,7 @@ Terraform will resize any Instance Group to zero when destroying the resource.
## Example Usage
```
resource "aws_emr_cluster_instance_group" "task" {
resource "aws_emr_instance_group" "task" {
cluster_id = "${aws_emr_cluster.tf-test-cluster.id}"
instance_count = 1
instance_type = "m3.xlarge"
@ -30,21 +29,25 @@ resource "aws_emr_cluster_instance_group" "task" {
## Argument Reference
The following arguments are supported:
* `name` (Required) Human friendly name given to the instance group. Changing this forces a new resource to be created.
* `cluster_id` (Required) ID of the EMR Cluster to attach to. Changing this forces a new resource to be created.
* `instance_type` (Required) The EC2 instance type for all instances in the instance group. Changing this forces a new resource to be created.
* `instance_count` (Optional) Target number of instances for the instance group. Defaults to 0.
* `ebs_optimized` (Optional) Indicates whether an Amazon EBS volume is EBS-optimized. Changing this forces a new resource to be created.
* `ebs_config` (Optional) One or more `ebs_config` blocks as defined below. Changing this forces a new resource to be created.
* `name` - (Optional) Optional human friendly name for this Instance Group
* `cluster_id` - (Required) ID of the EMR Cluster to attach to
* `instance_type` - (Required) Type of instances for this Group
* `instance_count` - (Optional) Count of instances to launch
`ebs_config` supports the following:
* `iops` - (Optional) The number of I/O operations per second (IOPS) that the volume supports.
* `size` - (Optional) The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.
* `type` - (Optional) The volume type. Valid options are 'gp2', 'io1' and 'standard'.
* `volumes_per_instance` - (Optional) The number of EBS Volumes to attach per instance.
## Attributes Reference
The following attributes are exported:
## ec2\_attributes
* `id` - The EMR Instance ID
Attributes for the Instance Group
* `running_instance_count` The number of instances currently running in this instance group.
* `name` - Human friendly name for this Instance Group
* `cluster_id` - ID of the EMR Cluster the group is attached to
* `instance_type` - Type of instances for this Group
* `instance_count` - Count of desired instances to launch
* `running_instance_count` - Count of actual running instances in the group
* `status` - State of the instance group. One of `PROVISIONING`, `BOOTSTRAPPING`, `RUNNING`, `RESIZING`, `SUSPENDED`, `TERMINATING`, `TERMINATED`, `ARRESTED`, `SHUTTING_DOWN`, `ENDED`
* `status` The current status of the instance group.