Allow Data Source for AWS instances to get instances that are in a state other than running

aws/data_source_aws_instances.go

@@ -8,6 +8,7 @@ import (
 	"github.com/aws/aws-sdk-go/service/ec2"
 	"github.com/hashicorp/terraform/helper/resource"
 	"github.com/hashicorp/terraform/helper/schema"
+	"github.com/hashicorp/terraform/helper/validation"
 )
 
 func dataSourceAwsInstances() *schema.Resource {
@@ -17,6 +18,21 @@ func dataSourceAwsInstances() *schema.Resource {
 		Schema: map[string]*schema.Schema{
 			"filter":        dataSourceFiltersSchema(),
 			"instance_tags": tagsSchemaComputed(),
+			"instance_state_names": {
+				Type:     schema.TypeSet,
+				Optional: true,
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+					ValidateFunc: validation.StringInSlice([]string{
+						ec2.InstanceStateNamePending,
+						ec2.InstanceStateNameRunning,
+						ec2.InstanceStateNameShuttingDown,
+						ec2.InstanceStateNameStopped,
+						ec2.InstanceStateNameStopping,
+						ec2.InstanceStateNameTerminated,
+					}, false),
+				},
+			},
 
 			"ids": {
 				Type:     schema.TypeList,
@@ -47,14 +63,19 @@ func dataSourceAwsInstancesRead(d *schema.ResourceData, meta interface{}) error
 		return fmt.Errorf("One of filters or instance_tags must be assigned")
 	}
 
+	instanceStateNames := []*string{aws.String(ec2.InstanceStateNameRunning)}
+	if v, ok := d.GetOk("instance_state_names"); ok && len(v.(*schema.Set).List()) > 0 {
+		instanceStateNames = expandStringSet(v.(*schema.Set))
+	}
 	params := &ec2.DescribeInstancesInput{
 		Filters: []*ec2.Filter{
 			&ec2.Filter{
 				Name:   aws.String("instance-state-name"),
-				Values: []*string{aws.String("running")},
+				Values: instanceStateNames,
 			},
 		},
 	}
+
 	if filtersOk {
 		params.Filters = append(params.Filters,
 			buildAwsDataSourceFilters(filters.(*schema.Set))...)

aws/data_source_aws_instances_test.go

@@ -43,6 +43,22 @@ func TestAccAWSInstancesDataSource_tags(t *testing.T) {
 	})
 }
 
+func TestAccAWSInstancesDataSource_instance_state_names(t *testing.T) {
+	rInt := acctest.RandInt()
+	resource.Test(t, resource.TestCase{
+		PreCheck:  func() { testAccPreCheck(t) },
+		Providers: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: testAccInstancesDataSourceConfig_instance_state_names(rInt),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr("data.aws_instances.test", "ids.#", "2"),
+				),
+			},
+		},
+	})
+}
+
 const testAccInstancesDataSourceConfig_ids = `
 data "aws_ami" "ubuntu" {
   most_recent = true
@@ -113,3 +129,41 @@ data "aws_instances" "test" {
 }
 `, rInt)
 }
+
+func testAccInstancesDataSourceConfig_instance_state_names(rInt int) string {
+	return fmt.Sprintf(`
+data "aws_ami" "ubuntu" {
+  most_recent = true
+
+  filter {
+    name   = "name"
+    values = ["ubuntu/images/hvm-ssd/ubuntu-trusty-14.04-amd64-server-*"]
+  }
+
+  filter {
+    name   = "virtualization-type"
+    values = ["hvm"]
+  }
+
+  owners = ["099720109477"] # Canonical
+}
+
+resource "aws_instance" "test" {
+  count = 2
+  ami = "${data.aws_ami.ubuntu.id}"
+  instance_type = "t2.micro"
+  tags {
+    Name = "TfAccTest-HelloWorld"
+    TestSeed = "%[1]d"
+  }
+}
+
+data "aws_instances" "test" {
+  instance_tags {
+    Name = "${aws_instance.test.0.tags["Name"]}"
+  }
+
+  instance_state_names = [ "pending", "running" ]
+}
+`, rInt)
+}

website/docs/d/instances.html.markdown

@@ -32,6 +32,8 @@ data "aws_instances" "test" {
     name   = "instance.group-id"
     values = ["sg-12345678"]
   }
+
+  instance_state_names = [ "running", "stopped" ]
 }
 
 resource "aws_eip" "test" {
@@ -45,6 +47,8 @@ resource "aws_eip" "test" {
 * `instance_tags` - (Optional) A mapping of tags, each pair of which must
 exactly match a pair on desired instances.
 
+* `instance_state_names` - (Optional) A list of instance states that should be applicable to the desired instances. The permitted values are: `pending, running, shutting-down, stopped, stopping, terminated`. The default value is `running`.
+
 * `filter` - (Optional) One or more name/value pairs to use as filters. There are
 several valid keys, for a full reference, check out
 [describe-instances in the AWS CLI reference][1].