Instance

Describes an instance.

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 | arm64 | x86_64_mac | arm64_mac

Required: No

blockDeviceMapping

Any block device mapping entries for the instance.

Type: Array of InstanceBlockDeviceMapping objects

Required: No

bootMode

The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start.

Note

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

Type: String

Valid Values: legacy-bios | uefi | uefi-preferred

Required: No

capacityReservationId

The ID of the Capacity Reservation.

Type: String

Required: No

capacityReservationSpecification

Information about the Capacity Reservation targeting option.

Type: CapacityReservationSpecificationResponse object

Required: No

clientToken

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

Type: String

Required: No

cpuOptions

The CPU options for the instance.

Type: CpuOptions object

Required: No

currentInstanceBootMode

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.

Type: String

Valid Values: legacy-bios | uefi

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. 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 Amazon 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

elasticGpuAssociationSet

Deprecated.

Note

Amazon Elastic Graphics reached end of life on January 8, 2024.

Type: Array of ElasticGpuAssociation objects

Required: No

elasticInferenceAcceleratorAssociationSet

Deprecated

Note

Amazon Elastic Inference is no longer available.

Type: Array of ElasticInferenceAcceleratorAssociation objects

Required: No

enaSupport

Specifies whether enhanced networking with ENA is enabled.

Type: Boolean

Required: No

enclaveOptions

Indicates whether the instance is enabled for AWS Nitro Enclaves.

Type: EnclaveOptions object

Required: No

groupSet

The security groups for the instance.

Type: Array of GroupIdentifier objects

Required: No

hibernationOptions

Indicates whether the instance is enabled for hibernation.

Type: HibernationOptions object

Required: No

hypervisor

The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

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 | capacity-block

Required: No

instanceState

The current state of the instance.

Type: InstanceState object

Required: No

instanceType

The instance type.

Type: String

Required: No

ipAddress

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

A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

Type: String

Required: No

ipv6Address

The IPv6 address assigned to the instance.

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 that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface.

Type: Timestamp

Required: No

licenseSet

The license configurations for the instance.

Type: Array of LicenseConfiguration objects

Required: No

maintenanceOptions

Provides information on the recovery and maintenance options of your instance.

Type: InstanceMaintenanceOptions object

Required: No

metadataOptions

The metadata options for the instance.

Type: InstanceMetadataOptionsResponse object

Required: No

monitoring

The monitoring for the instance.

Type: Monitoring object

Required: No

networkInterfaceSet

The network interfaces for the instance.

Type: Array of InstanceNetworkInterface objects

Required: No

operator

The entity that manages the instance.

Type: OperatorResponse object

Required: No

outpostArn

The Amazon Resource Name (ARN) of the Outpost.

Type: String

Required: No

placement

The location where the instance launched, if applicable.

Type: Placement object

Required: No

platform

The platform. This value is windows for Windows instances; otherwise, it is empty.

Type: String

Valid Values: windows

Required: No

platformDetails

The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

Type: String

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.

The Amazon-provided DNS server resolves 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

privateDnsNameOptions

The options for the instance hostname.

Type: PrivateDnsNameOptionsResponse object

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 device name of the root device volume (for example, /dev/sda1).

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

Indicates whether source/destination checking is enabled.

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

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

tpmSupport

If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

Type: String

Required: No

usageOperation

The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

Type: String

Required: No

usageOperationUpdateTime

The time that the usage operation was last updated.

Type: Timestamp

Required: No

virtualizationType

The virtualization type of the instance.

Type: String

Valid Values: hvm | paravirtual

Required: No

vpcId

The ID of the VPC in which the instance is running.

Type: String

Required: No

Instance

Contents

Note

Note

Note

See Also