You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes an image.

Instance Attribute Summary collapse

Instance Attribute Details

#architectureString

The architecture of the image.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_mappingsArray<Types::BlockDeviceMapping>

Any block device mapping entries.

Returns:



21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_dateString

The date and time the image was created.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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

#descriptionString

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

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_supportBoolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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

#hypervisorString

The hypervisor type of the image.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_idString

The ID of the AMI.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_locationString

The location of the AMI.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_aliasString

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

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_typeString

The type of image.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_idString

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

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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

#nameString

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

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_idString

The AWS account ID of the image owner.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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

#platformString

The value is Windows for Windows AMIs; otherwise blank.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_codesArray<Types::ProductCode>

Any product codes associated with the AMI.

Returns:



21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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

#publicBoolean

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)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_idString

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

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_nameString

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

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_typeString

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

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_supportString

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

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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

#stateString

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)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_reasonTypes::StateReason

The reason for the state change.

Returns:



21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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

#tagsArray<Types::Tag>

Any tags assigned to the image.

Returns:



21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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_typeString

The type of virtualization of the AMI.

Returns:

  • (String)


21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 21449

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