Class: Aws::EC2::Types::Image

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::Image

Includes:

Structure

Defined in:

lib/aws-sdk-ec2/types.rb

Overview

Describes an image.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #architecture ⇒ String

  The architecture of the image.

• #block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

  Any block device mapping entries.

• #creation_date ⇒ String

  The date and time the image was created.

• #description ⇒ String

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

• #ena_support ⇒ Boolean

  Specifies whether enhanced networking with ENA is enabled.

• #hypervisor ⇒ String

  The hypervisor type of the image.

• #image_id ⇒ String

  The ID of the AMI.

• #image_location ⇒ String

  The location of the AMI.

• #image_owner_alias ⇒ String

  The AWS account alias (for example, ‘amazon`, `self`) or the AWS account ID of the AMI owner.

• #image_type ⇒ String

  The type of image.

• #kernel_id ⇒ String

  The kernel associated with the image, if any.

• #name ⇒ String

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

• #owner_id ⇒ String

  The AWS account ID of the image owner.

• #platform ⇒ String

  The value is ‘Windows` for Windows AMIs; otherwise blank.

• #product_codes ⇒ Array<Types::ProductCode>

  Any product codes associated with the AMI.

• #public ⇒ Boolean

  Indicates whether the image has public launch permissions.

• #ramdisk_id ⇒ String

  The RAM disk associated with the image, if any.

• #root_device_name ⇒ String

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

• #root_device_type ⇒ String

  The type of root device used by the AMI.

• #sriov_net_support ⇒ String

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

• #state ⇒ String

  The current state of the AMI.

• #state_reason ⇒ Types::StateReason

  The reason for the state change.

• #tags ⇒ Array<Types::Tag>

  Any tags assigned to the image.

• #virtualization_type ⇒ String

  The type of virtualization of the AMI.

Instance Attribute Details

#architecture ⇒ String

The architecture of the image.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

Any block device mapping entries.

Returns:

• (Array<Types::BlockDeviceMapping>)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#creation_date ⇒ String

The date and time the image was created.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#ena_support ⇒ Boolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#hypervisor ⇒ String

The hypervisor type of the image.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#image_id ⇒ String

The ID of the AMI.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#image_location ⇒ String

The location of the AMI.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#image_owner_alias ⇒ String

The AWS account alias (for example, ‘amazon`, `self`) or the AWS account ID of the AMI owner.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#image_type ⇒ String

The type of image.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#kernel_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#owner_id ⇒ String

The AWS account ID of the image owner.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#platform ⇒ String

The value is ‘Windows` for Windows AMIs; otherwise blank.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#product_codes ⇒ Array<Types::ProductCode>

Any product codes associated with the AMI.

Returns:

• (Array<Types::ProductCode>)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#public ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#ramdisk_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#root_device_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#root_device_type ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#sriov_net_support ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#state ⇒ String

The current state of the AMI. If the state is ‘available`, the image is successfully registered and can be used to launch an instance.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#state_reason ⇒ Types::StateReason

The reason for the state change.

Returns:

• (Types::StateReason)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the image.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end

#virtualization_type ⇒ String

The type of virtualization of the AMI.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 21055

class Image < Struct.new(
  :architecture,
  :creation_date,
  :image_id,
  :image_location,
  :image_type,
  :public,
  :kernel_id,
  :owner_id,
  :platform,
  :product_codes,
  :ramdisk_id,
  :state,
  :block_device_mappings,
  :description,
  :ena_support,
  :hypervisor,
  :image_owner_alias,
  :name,
  :root_device_name,
  :root_device_type,
  :sriov_net_support,
  :state_reason,
  :tags,
  :virtualization_type)
  include Aws::Structure
end