github.com/alexissmirnov/terraform@v0.4.3-0.20150423153700-1ef9731a2f14/website/source/docs/providers/aws/r/instance.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_instance"
     4  sidebar_current: "docs-aws-resource-instance"
     5  description: |-
     6    Provides an EC2 instance resource. This allows instances to be created, updated, and deleted. Instances also support provisioning.
     7  ---
     8  
     9  # aws\_instance
    10  
    11  Provides an EC2 instance resource. This allows instances to be created, updated,
    12  and deleted. Instances also support [provisioning](/docs/provisioners/index.html).
    13  
    14  ## Example Usage
    15  
    16  ```
    17  # Create a new instance of the ami-1234 on an m1.small node
    18  # with an AWS Tag naming it "HelloWorld"
    19  resource "aws_instance" "web" {
    20      ami = "ami-1234"
    21      instance_type = "m1.small"
    22      tags {
    23          Name = "HelloWorld"
    24      }
    25  }
    26  ```
    27  
    28  ## Argument Reference
    29  
    30  The following arguments are supported:
    31  
    32  * `ami` - (Required) The AMI to use for the instance.
    33  * `availability_zone` - (Optional) The AZ to start the instance in.
    34  * `placement_group` - (Optional) The Placement Group to start the instance in.
    35  * `ebs_optimized` - (Optional) If true, the launched EC2 instance will be
    36       EBS-optimized.
    37  * `instance_type` - (Required) The type of instance to start
    38  * `key_name` - (Optional) The key name to use for the instance.
    39  * `security_groups` - (Optional) A list of security group names to associate with.
    40     If you are within a non-default VPC, you'll need to use `vpc_security_group_ids` instead.
    41  * `vpc_security_group_ids` - (Optional) A list of security group IDs to associate with.
    42  * `subnet_id` - (Optional) The VPC Subnet ID to launch in.
    43  * `associate_public_ip_address` - (Optional) Associate a public ip address with an instance in a VPC.
    44  * `private_ip` - (Optional) Private IP address to associate with the
    45       instance in a VPC.
    46  * `source_dest_check` - (Optional) Controls if traffic is routed to the instance when
    47    the destination address does not match the instance. Used for NAT or VPNs. Defaults true.
    48  * `user_data` - (Optional) The user data to provide when launching the instance.
    49  * `iam_instance_profile` - (Optional) The IAM Instance Profile to
    50    launch the instance with.
    51  * `tags` - (Optional) A mapping of tags to assign to the resource.
    52  * `root_block_device` - (Optional) Customize details about the root block
    53    device of the instance. See [Block Devices](#block-devices) below for details.
    54  * `ebs_block_device` - (Optional) Additional EBS block devices to attach to the
    55    instance.  See [Block Devices](#block-devices) below for details.
    56  * `ephemeral_block_device` - (Optional) Customize Ephemeral (also known as
    57    "Instance Store") volumes on the instance. See [Block Devices](#block-devices) below for details.
    58  
    59  
    60  <a id="block-devices"></a>
    61  ## Block devices
    62  
    63  Each of the `*_block_device` attributes controls a portion of the AWS
    64  Instance's "Block Device Mapping". It's a good idea to familiarize yourself with [AWS's Block Device
    65  Mapping docs](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html)
    66  to understand the implications of using these attributes.
    67  
    68  The `root_block_device` mapping supports the following:
    69  
    70  * `volume_type` - (Optional) The type of volume. Can be `"standard"`, `"gp2"`,
    71    or `"io1"`. (Default: `"standard"`).
    72  * `volume_size` - (Optional) The size of the volume in gigabytes.
    73  * `iops` - (Optional) The amount of provisioned
    74    [IOPS](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-io-characteristics.html).
    75    This must be set with a `volume_type` of `"io1"`.
    76  * `delete_on_termination` - (Optional) Whether the volume should be destroyed
    77    on instance termination (Default: `true`).
    78  
    79  Modifying any of the `root_block_device` settings requires resource
    80  replacement.
    81  
    82  Each `ebs_block_device` supports the following:
    83  
    84  * `device_name` - The name of the device to mount.
    85  * `snapshot_id` - (Optional) The Snapshot ID to mount.
    86  * `volume_type` - (Optional) The type of volume. Can be `"standard"`, `"gp2"`,
    87    or `"io1"`. (Default: `"standard"`).
    88  * `volume_size` - (Optional) The size of the volume in gigabytes.
    89  * `iops` - (Optional) The amount of provisioned
    90    [IOPS](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-io-characteristics.html).
    91    This must be set with a `volume_type` of `"io1"`.
    92  * `delete_on_termination` - (Optional) Whether the volume should be destroyed
    93    on instance termination (Default: `true`).
    94  * `encrypted` - (Optional) Enables [EBS
    95    encryption](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html)
    96    on the volume (Default: `false`).
    97  
    98  Modifying any `ebs_block_device` currently requires resource replacement.
    99  
   100  Each `ephemeral_block_device` supports the following:
   101  
   102  * `device_name` - The name of the block device to mount on the instance.
   103  * `virtual_name` - The [Instance Store Device
   104    Name](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#InstanceStoreDeviceNames)
   105    (e.g. `"ephemeral0"`)
   106  
   107  Each AWS Instance type has a different set of Instance Store block devices
   108  available for attachment. AWS [publishes a
   109  list](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html#StorageOnInstanceTypes)
   110  of which ephemeral devices are available on each type. The devices are always
   111  identified by the `virtual_name` in the format `"ephemeral{0..N}"`.
   112  
   113  ~> **NOTE:** Currently, changes to `*_block_device` configuration of _existing_
   114  resources cannot be automatically detected by Terraform. After making updates
   115  to block device configuration, resource recreation can be manually triggered by
   116  using the [`taint` command](/docs/commands/taint.html).
   117  
   118  ## Attributes Reference
   119  
   120  The following attributes are exported:
   121  
   122  * `id` - The instance ID.
   123  * `availability_zone` - The availability zone of the instance.
   124  * `placement_group` - The placement group of the instance.
   125  * `key_name` - The key name of the instance
   126  * `private_dns` - The Private DNS name of the instance
   127  * `private_ip` - The private IP address.
   128  * `public_dns` - The public DNS name of the instance
   129  * `public_ip` - The public IP address.
   130  * `security_groups` - The associated security groups.
   131  * `vpc_security_group_ids` - The associated security groups in non-default VPC
   132  * `subnet_id` - The VPC subnet ID.