mirror of https://github.com/opentffoundation/opentf.git synced 2026-03-16 19:00:27 -04:00

Files

Paul Hinze 73d20b4c58 providers/aws: add root_block_device to aws_instance

AWS provides a single `BlockDeviceMapping` to manage three different
kinds of block devices:

 (a) The root volume
 (b) Ephemeral storage
 (c) Additional EBS volumes

Each of these types has slightly different semantics [1].

(a) The root volume is defined by the AMI; it can only be customized
with `volume_size`, `volume_type`, and `delete_on_termination`.

(b) Ephemeral storage is made available based on instance type [2]. It's
attached automatically if _no_ block device mappings are specified, and
must otherwise be defined with block device mapping entries that contain
only DeviceName set to a device like "/dev/sdX" and VirtualName set to
"ephemeralN".

(c) Additional EBS volumes are controlled by mappings that omit
`virtual_name` and can specify `volume_size`, `volume_type`,
`delete_on_termination`, `snapshot_id`, and `encryption`.

After deciding to ignore root block devices to fix #859, we had users
with configurations that were attempting to manage the root block device chime
in on #913.

Terraform does not have the primitives to be able to properly handle a
single collection of resources that is partially managed and partially
computed, so our strategy here is to break out logical sub-resources for
Terraform and hide the BlockDeviceMapping inside the provider
implementation.

Now (a) is supported by the `root_block_device` sub-resource, and (b)
and (c) are still both merged together under `block_device`, though I
have yet to see ephemeral block devices working properly.

Looking into possibly separating out `ephemeral_block_device` and
`ebs_block_device` sub-resources as well, which seem like the logical
next step. We'll wait until the next big release for this, though, since
it will break backcompat.

[1] http://bit.ly/ec2bdmap
[2] http://bit.ly/instancestorebytype

Fixes #913
Refs #858

2015-02-18 13:15:11 -06:00

3.7 KiB

Raw Blame History

layout, page_title, sidebar_current, description

layout	page_title	sidebar_current	description
aws	AWS: aws_instance	docs-aws-resource-instance	Provides an EC2 instance resource. This allows instances to be created, updated, and deleted. Instances also support provisioning.

aws_instance

Provides an EC2 instance resource. This allows instances to be created, updated, and deleted. Instances also support provisioning.

Example Usage

# Create a new instance of the ami-1234 on an m1.small node with an AWS Tag naming it "HelloWorld"
resource "aws_instance" "web" {
    ami = "ami-1234"
    instance_type = "m1.small"
    tags {
        Name = "HelloWorld"
    }
}

Argument Reference

The following arguments are supported:

ami - (Required) The AMI to use for the instance.
availability_zone - (Optional) The AZ to start the instance in.
ebs_optimized - (Optional) If true, the launched EC2 instance will be EBS-optimized.
instance_type - (Required) The type of instance to start
key_name - (Optional) The key name to use for the instance.
security_groups - (Optional) A list of security group IDs or names to associate with. If you are within a non-default VPC, you'll need to use the security group ID. Otherwise, for EC2 and the default VPC, use the security group name.
subnet_id - (Optional) The VPC Subnet ID to launch in.
associate_public_ip_address - (Optional) Associate a public ip address with an instance in a VPC.
private_ip - (Optional) Private IP address to associate with the instance in a VPC.
source_dest_check - (Optional) Controls if traffic is routed to the instance when the destination address does not match the instance. Used for NAT or VPNs. Defaults true.
user_data - (Optional) The user data to provide when launching the instance.
iam_instance_profile - (Optional) The IAM Instance Profile to launch the instance with.
tags - (Optional) A mapping of tags to assign to the resource.
block_device - (Optional) A list of block devices to add. Their keys are documented below.
root_block_device - (Optional) Customize details about the root block device of the instance. Available keys are documented below.

Each block_device supports the following:

device_name - The name of the device to mount.
virtual_name - (Optional) The virtual device name.
snapshot_id - (Optional) The Snapshot ID to mount.
volume_type - (Optional) The type of volume. Can be standard, gp2, or io1. Defaults to standard.
volume_size - (Optional) The size of the volume in gigabytes.
delete_on_termination - (Optional) Should the volume be destroyed on instance termination (defaults true).
encrypted - (Optional) Should encryption be enabled (defaults false).

The root_block_device mapping supports the following:

device_name - The name of the root device on the target instance. Must match the root device as defined in the AMI. Defaults to "/dev/sda1", which is the typical root volume for Linux instances.
volume_type - (Optional) The type of volume. Can be standard, gp2, or io1. Defaults to standard.
volume_size - (Optional) The size of the volume in gigabytes.
delete_on_termination - (Optional) Should the volume be destroyed on instance termination (defaults true).

Attributes Reference

The following attributes are exported:

id - The instance ID.
availability_zone - The availability zone of the instance.
key_name - The key name of the instance
private_dns - The Private DNS name of the instance
private_ip - The private IP address.
public_dns - The public DNS name of the instance
public_ip - The public IP address.
security_groups - The associated security groups.
subnet_id - The VPC subnet ID.

3.7 KiB Raw Blame History

aws_instance

Example Usage

Argument Reference

Attributes Reference

3.7 KiB

Raw Blame History