94 lines
4.2 KiB
Markdown
94 lines
4.2 KiB
Markdown
|
---
|
||
|
|
layout: "aws"
|
||
|
|
page_title: "AWS: aws_instance"
|
||
|
|
sidebar_current: "docs-aws-datasource-instance"
|
||
|
|
description: |-
|
||
|
|
Get information on a Amazon EC2 Instance.
|
||
|
|
---
|
||
|
|
|
||
|
|
# aws\_instance
|
||
|
|
|
||
|
|
Use this data source to get the ID of an EC2 Instance for use in other
|
||
|
|
resources.
|
||
|
|
|
||
|
|
## Example Usage
|
||
|
|
|
||
|
|
```
|
||
|
|
data "aws_instance" "foo" {
|
||
|
|
instance_id = "i-instanceid"
|
||
|
|
filter {
|
||
|
|
name = "image-id"
|
||
|
|
values = ["ami-xxxxxxxx"]
|
||
|
|
}
|
||
|
|
filter {
|
||
|
|
name = "tag:Name"
|
||
|
|
values = ["instance-name-tag"]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Argument Reference
|
||
|
|
|
||
|
|
* `instance_id` - (Optional) Specify the exact Instance ID to populate the data source with.
|
||
|
|
|
||
|
|
* `filter` - (Optional) One or more name/value pairs to filter off of. There are
|
||
|
|
several valid keys, for a full reference, check out
|
||
|
|
[describe-instances in the AWS CLI reference][1].
|
||
|
|
|
||
|
|
~> **NOTE:** At least one of `filter` or `instance_id` must be specified.
|
||
|
|
|
||
|
|
~> **NOTE:** If more or less than a single match is returned by the search,
|
||
|
|
Terraform will fail. Ensure that your search is specific enough to return
|
||
|
|
a single Instance ID only.
|
||
|
|
|
||
|
|
## Attributes Reference
|
||
|
|
|
||
|
|
`id` is set to the ID of the found Instance. In addition, the following attributes
|
||
|
|
are exported:
|
||
|
|
|
||
|
|
~> **NOTE:** Some values are not always set and may not be available for
|
||
|
|
interpolation.
|
||
|
|
|
||
|
|
* `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.
|
||
|
|
* `ebs_block_device` - The EBS block device mappings of the instance.
|
||
|
|
* `delete_on_termination` - If the EBS volume will be deleted on termination.
|
||
|
|
* `device_name` - The physical name of the device.
|
||
|
|
* `encrypted` - If the EBS volume is encrypted.
|
||
|
|
* `iops` - `0` If the EBS volume is not a provisioned IOPS image, otherwise the supported IOPS count.
|
||
|
|
* `snapshot_id` - The ID of the snapshot.
|
||
|
|
* `volume_size` - The size of the volume, in GiB.
|
||
|
|
* `volume_type` - The volume type.
|
||
|
|
* `ebs_optimized` - Whether the instance is ebs optimized or not (Boolean).
|
||
|
|
* `ephemeral_block_device` - The ephemeral block device mappings of the instance.
|
||
|
|
* `device_name` - The physical name of the device.
|
||
|
|
* `no_device` - Whether the specified device included in the device mapping was suppressed or not (Boolean).
|
||
|
|
* `virtual_name` - The virtual device name
|
||
|
|
* `iam_instance_profile` - The instance profile associated with the instance. Specified as an ARN.
|
||
|
|
* `instance_type` - The type of the instance.
|
||
|
|
* `key_name` - The key name of the instance.
|
||
|
|
* `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.
|
||
|
|
* `placement_group` - The placement group of the instance.
|
||
|
|
* `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
|
||
|
|
for your VPC.
|
||
|
|
* `private_ip` - The private IP address assigned to the instance.
|
||
|
|
* `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.
|
||
|
|
* `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
|
||
|
|
* `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.
|
||
|
|
* `volume_size` - The size of the volume, in GiB.
|
||
|
|
* `volume_type` - The type of the volume.
|
||
|
|
* `security_groups` - The associated security groups.
|
||
|
|
* `source_dest_check` - Whether the network interface performs source/destination checking (Boolean).
|
||
|
|
* `subnet_id` - The VPC subnet ID.
|
||
|
|
* `user_data` - The User Data supplied to the instance.
|
||
|
|
* `tags` - A mapping of tags assigned to the instance.
|
||
|
|
* `tenancy` - The tenancy of the instance (dedicated | default | host ).
|
||
|
|
* `vpc_security_group_ids` - The associated security groups in non-default VPC.
|
||
|
|
|
||
|
|
[1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html
|