Instance

class Instance

Describes an instance.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

The architecture of the image.

Link copied to clipboard

Any block device mapping entries for the instance.

Link copied to clipboard

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.

Link copied to clipboard

The ID of the Capacity Block.

Link copied to clipboard

The ID of the Capacity Reservation.

Link copied to clipboard

Information about the Capacity Reservation targeting option.

Link copied to clipboard

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

Link copied to clipboard

The CPU options for the instance.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

Specifies whether enhanced networking with ENA is enabled.

Link copied to clipboard

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

Link copied to clipboard

Indicates whether the instance is enabled for hibernation.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The ID of the AMI used to launch the instance.

Link copied to clipboard

The ID of the instance.

Link copied to clipboard

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

Link copied to clipboard

The instance type.

Link copied to clipboard

The IPv6 address assigned to the instance.

Link copied to clipboard

The kernel associated with this instance, if applicable.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The license configurations for the instance.

Link copied to clipboard

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

Link copied to clipboard

The metadata options for the instance.

Link copied to clipboard

The monitoring for the instance.

Link copied to clipboard

The network interfaces for the instance.

Link copied to clipboard

Contains settings for the network performance options for your instance.

Link copied to clipboard

The service provider that manages the instance.

Link copied to clipboard

The Amazon Resource Name (ARN) of the Outpost.

Link copied to clipboard

The location where the instance launched, if applicable.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The options for the instance hostname.

Link copied to clipboard

The private IPv4 address assigned to the instance.

Link copied to clipboard

The product codes attached to this instance, if applicable.

Link copied to clipboard

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. The format of this name depends on the public hostname type.

Link copied to clipboard

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

Link copied to clipboard

The RAM disk associated with this instance, if applicable.

Link copied to clipboard

The device name of the root device volume (for example, /dev/sda1).

Link copied to clipboard

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

Link copied to clipboard

The security groups for the instance.

Link copied to clipboard

Indicates whether source/destination checking is enabled.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The current state of the instance.

Link copied to clipboard

The reason for the most recent state transition.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val tags: List<Tag>?

Any tags assigned to the instance.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The time that the usage operation was last updated.

Link copied to clipboard

The virtualization type of the instance.

Link copied to clipboard

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

Functions

Link copied to clipboard
inline fun copy(block: Instance.Builder.() -> Unit = {}): Instance
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String