Merge pull request #11698 from jamtur01/patch-17

Minor grammar fixes to AWS Instance data source
This commit is contained in:
James Nugent 2017-02-04 17:05:06 +01:00 committed by GitHub
commit 983104b29a
1 changed files with 26 additions and 26 deletions

View File

@ -3,12 +3,12 @@ layout: "aws"
page_title: "AWS: aws_instance" page_title: "AWS: aws_instance"
sidebar_current: "docs-aws-datasource-instance" sidebar_current: "docs-aws-datasource-instance"
description: |- description: |-
Get information on a Amazon EC2 Instance. Get information on an Amazon EC2 Instance.
--- ---
# aws\_instance # aws\_instance
Use this data source to get the ID of an EC2 Instance for use in other Use this data source to get the ID of an Amazon EC2 Instance for use in other
resources. resources.
## Example Usage ## Example Usage
@ -29,18 +29,18 @@ data "aws_instance" "foo" {
## Argument Reference ## Argument Reference
* `instance_id` - (Optional) Specify the exact Instance ID to populate the data source with. * `instance_id` - (Optional) Specify the exact Instance ID with which to populate the data source.
* `instance_tags` - (Optional) A mapping of tags, each pair of which must * `instance_tags` - (Optional) A mapping of tags, each pair of which must
exactly match a pair on the desired Instance. exactly match a pair on the desired Instance.
* `filter` - (Optional) One or more name/value pairs to filter off of. There are * `filter` - (Optional) One or more name/value pairs to use as filters. There are
several valid keys, for a full reference, check out several valid keys, for a full reference, check out
[describe-instances in the AWS CLI reference][1]. [describe-instances in the AWS CLI reference][1].
~> **NOTE:** At least one of `filter`, `instance_tags`, or `instance_id` must be specified. ~> **NOTE:** At least one of `filter`, `instance_tags`, or `instance_id` must be specified.
~> **NOTE:** If more or less than a single match is returned by the search, ~> **NOTE:** If anything other than a single match is returned by the search,
Terraform will fail. Ensure that your search is specific enough to return Terraform will fail. Ensure that your search is specific enough to return
a single Instance ID only. a single Instance ID only.
@ -52,9 +52,9 @@ are exported:
~> **NOTE:** Some values are not always set and may not be available for ~> **NOTE:** Some values are not always set and may not be available for
interpolation. interpolation.
* `associate_public_ip_address` - Whether or not the instance is associated with a public ip address or not (Boolean). * `associate_public_ip_address` - Whether or not the Instance is associated with a public IP address or not (Boolean).
* `availability_zone` - The availability zone of the instance. * `availability_zone` - The availability zone of the Instance.
* `ebs_block_device` - The EBS block device mappings of the instance. * `ebs_block_device` - The EBS block device mappings of the Instance.
* `delete_on_termination` - If the EBS volume will be deleted on termination. * `delete_on_termination` - If the EBS volume will be deleted on termination.
* `device_name` - The physical name of the device. * `device_name` - The physical name of the device.
* `encrypted` - If the EBS volume is encrypted. * `encrypted` - If the EBS volume is encrypted.
@ -62,25 +62,25 @@ interpolation.
* `snapshot_id` - The ID of the snapshot. * `snapshot_id` - The ID of the snapshot.
* `volume_size` - The size of the volume, in GiB. * `volume_size` - The size of the volume, in GiB.
* `volume_type` - The volume type. * `volume_type` - The volume type.
* `ebs_optimized` - Whether the instance is ebs optimized or not (Boolean). * `ebs_optimized` - Whether the Instance is EBS optimized or not (Boolean).
* `ephemeral_block_device` - The ephemeral block device mappings of the instance. * `ephemeral_block_device` - The ephemeral block device mappings of the Instance.
* `device_name` - The physical name of the device. * `device_name` - The physical name of the device.
* `no_device` - Whether the specified device included in the device mapping was suppressed or not (Boolean). * `no_device` - Whether the specified device included in the device mapping was suppressed or not (Boolean).
* `virtual_name` - The virtual device name * `virtual_name` - The virtual device name.
* `iam_instance_profile` - The instance profile associated with the instance. Specified as an ARN. * `iam_instance_profile` - The instance profile associated with the Instance. Specified as an ARN.
* `instance_type` - The type of the instance. * `instance_type` - The type of the Instance.
* `key_name` - The key name of the instance. * `key_name` - The key name of the Instance.
* `monitoring` - Whether detailed monitoring is enabled or disabled for the instance (Boolean). * `monitoring` - Whether detailed monitoring is enabled or disabled for the Instance (Boolean).
* `network_interface_id` - The ID of the network interface that was created with the instance. * `network_interface_id` - The ID of the network interface that was created with the Instance.
* `placement_group` - The placement group of the instance. * `placement_group` - The placement group of the Instance.
* `private_dns` - The private DNS name assigned to the instance. Can only be * `private_dns` - The private DNS name assigned to the Instance. Can only be
used inside the Amazon EC2, and only available if you've enabled DNS hostnames used inside the Amazon EC2, and only available if you've enabled DNS hostnames
for your VPC. for your VPC.
* `private_ip` - The private IP address assigned to the instance. * `private_ip` - The private IP address assigned to the Instance.
* `public_dns` - The public DNS name assigned to the instance. For EC2-VPC, this * `public_dns` - The public DNS name assigned to the Instance. For EC2-VPC, this
is only available if you've enabled DNS hostnames for your VPC. is only available if you've enabled DNS hostnames for your VPC.
* `public_ip` - The public IP address assigned to the instance, if applicable. **NOTE**: If you are using an [`aws_eip`](/docs/providers/aws/r/eip.html) with your instance, you should refer to the EIP's address directly and not use `public_ip`, as this field will change after the EIP is attached. * `public_ip` - The public IP address assigned to the Instance, if applicable. **NOTE**: If you are using an [`aws_eip`](/docs/providers/aws/r/eip.html) with your instance, you should refer to the EIP's address directly and not use `public_ip`, as this field will change after the EIP is attached.
* `root_block_device` - The root block device mappings of the instance * `root_block_device` - The root block device mappings of the Instance
* `delete_on_termination` - If the root block device will be deleted on termination. * `delete_on_termination` - If the root block device will be deleted on termination.
* `iops` - `0` If the volume is not a provisioned IOPS image, otherwise the supported IOPS count. * `iops` - `0` If the volume is not a provisioned IOPS image, otherwise the supported IOPS count.
* `volume_size` - The size of the volume, in GiB. * `volume_size` - The size of the volume, in GiB.
@ -88,9 +88,9 @@ interpolation.
* `security_groups` - The associated security groups. * `security_groups` - The associated security groups.
* `source_dest_check` - Whether the network interface performs source/destination checking (Boolean). * `source_dest_check` - Whether the network interface performs source/destination checking (Boolean).
* `subnet_id` - The VPC subnet ID. * `subnet_id` - The VPC subnet ID.
* `user_data` - The User Data supplied to the instance. * `user_data` - The User Data supplied to the Instance.
* `tags` - A mapping of tags assigned to the instance. * `tags` - A mapping of tags assigned to the Instance.
* `tenancy` - The tenancy of the instance (dedicated | default | host ). * `tenancy` - The tenancy of the instance: `dedicated`, `default`, `host`.
* `vpc_security_group_ids` - The associated security groups in non-default VPC. * `vpc_security_group_ids` - The associated security groups in a non-default VPC.
[1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html