Image

class Image

Describes an image.

Types

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

Properties

Link copied to clipboard

The architecture of the image.

Link copied to clipboard

Any block device mapping entries.

Link copied to clipboard

The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.

Link copied to clipboard

The date and time the image was created.

Link copied to clipboard

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

Link copied to clipboard

The description of the AMI that was provided during image creation.

Link copied to clipboard

Specifies whether enhanced networking with ENA is enabled.

Link copied to clipboard

The hypervisor type of the image. Only xen is supported. ovm is not supported.

Link copied to clipboard

The ID of the AMI.

Link copied to clipboard

The location of the AMI.

Link copied to clipboard

The Amazon Web Services account alias (for example, amazon, self) or the Amazon Web Services account ID of the AMI owner.

Link copied to clipboard

The type of image.

Link copied to clipboard

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

Link copied to clipboard

The kernel associated with the image, if any. Only applicable for machine images.

Link copied to clipboard
val name: String?

The name of the AMI that was provided during image creation.

Link copied to clipboard

The ID of the Amazon Web Services account that owns the image.

Link copied to clipboard

This value is set to windows for Windows AMIs; otherwise, it is blank.

Link copied to clipboard

The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

Link copied to clipboard

Any product codes associated with the AMI.

Link copied to clipboard

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

Link copied to clipboard

The RAM disk associated with the image, if any. Only applicable for machine images.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

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 AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

Link copied to clipboard

The reason for the state change.

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

Any tags assigned to the image.

Link copied to clipboard

If the image 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 operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.

Link copied to clipboard

The type of virtualization of the AMI.

Functions

Link copied to clipboard
inline fun copy(block: Image.Builder.() -> Unit = {}): Image
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