Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

Instance

Describes an instance.

Contents

amiLaunchIndex

The AMI launch index, which can be used to find this instance in the launch group.

Type: Integer

Required: No

architecture

The architecture of the image.

Type: String

Valid Values: i386 | x86_64

Required: No

blockDeviceMapping

Any block device mapping entries for the instance.

Type: Array of InstanceBlockDeviceMapping objects

Required: No

clientToken

The idempotency token you provided when you launched the instance, if applicable.

Type: String

Required: No

dnsName

(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

Type: String

Required: No

ebsOptimized

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Type: Boolean

Required: No

enaSupport

Specifies whether enhanced networking with ENA is enabled.

Type: Boolean

Required: No

groupSet

One or more security groups for the instance.

Type: Array of GroupIdentifier objects

Required: No

hypervisor

The hypervisor type of the instance.

Type: String

Valid Values: ovm | xen

Required: No

iamInstanceProfile

The IAM instance profile associated with the instance, if applicable.

Type: IamInstanceProfile object

Required: No

imageId

The ID of the AMI used to launch the instance.

Type: String

Required: No

instanceId

The ID of the instance.

Type: String

Required: No

instanceLifecycle

Indicates whether this is a Spot instance or a Scheduled Instance.

Type: String

Valid Values: spot | scheduled

Required: No

instanceState

The current state of the instance.

Type: InstanceState object

Required: No

instanceType

The instance type.

Type: String

Valid Values: t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | cr1.8xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | x1.16xlarge | x1.32xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | hi1.4xlarge | hs1.8xlarge | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | cc1.4xlarge | cc2.8xlarge | g2.2xlarge | g2.8xlarge | cg1.4xlarge | p2.xlarge | p2.8xlarge | p2.16xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | f1.2xlarge | f1.16xlarge

Required: No

ipAddress

The public IPv4 address assigned to the instance, if applicable.

Type: String

Required: No

kernelId

The kernel associated with this instance, if applicable.

Type: String

Required: No

keyName

The name of the key pair, if this instance was launched with an associated key pair.

Type: String

Required: No

launchTime

The time the instance was launched.

Type: Timestamp

Required: No

monitoring

The monitoring for the instance.

Type: Monitoring object

Required: No

networkInterfaceSet

[EC2-VPC] One or more network interfaces for the instance.

Type: Array of InstanceNetworkInterface objects

Required: No

placement

The location where the instance launched, if applicable.

Type: Placement object

Required: No

platform

The value is Windows for Windows instances; otherwise blank.

Type: String

Valid Values: Windows

Required: No

privateDnsName

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

[EC2-VPC] The Amazon-provided DNS server will resolve Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

Type: String

Required: No

privateIpAddress

The private IPv4 address assigned to the instance.

Type: String

Required: No

productCodes

The product codes attached to this instance, if applicable.

Type: Array of ProductCode objects

Required: No

ramdiskId

The RAM disk associated with this instance, if applicable.

Type: String

Required: No

reason

The reason for the most recent state transition. This might be an empty string.

Type: String

Required: No

rootDeviceName

The root device name (for example, /dev/sda1 or /dev/xvda).

Type: String

Required: No

rootDeviceType

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

Type: String

Valid Values: ebs | instance-store

Required: No

sourceDestCheck

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

Type: Boolean

Required: No

spotInstanceRequestId

If the request is a Spot instance request, the ID of the request.

Type: String

Required: No

sriovNetSupport

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

Type: String

Required: No

stateReason

The reason for the most recent state transition.

Type: StateReason object

Required: No

subnetId

[EC2-VPC] The ID of the subnet in which the instance is running.

Type: String

Required: No

tagSet

Any tags assigned to the instance.

Type: Array of Tag objects

Required: No

virtualizationType

The virtualization type of the instance.

Type: String

Valid Values: hvm | paravirtual

Required: No

vpcId

[EC2-VPC] The ID of the VPC in which the instance is running.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: