You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::EC2::Image Instance Attribute Summary collapseThe architecture of the image.
Any block device mapping entries.
The date and time the image was created.
The description of the AMI that was provided during image creation.
Specifies whether enhanced networking with ENA is enabled.
The hypervisor type of the image.
The ID of the AMI.
The location of the AMI.
The AWS account alias (for example, amazon
, self
) or the AWS account ID of the AMI owner.
The type of image.
The kernel associated with the image, if any.
The name of the AMI that was provided during image creation.
The AWS account ID of the image owner.
This value is set to windows
for Windows AMIs; otherwise, it is blank.
The platform details associated with the billing code of the AMI.
Any product codes associated with the AMI.
Indicates whether the image has public launch permissions.
The RAM disk associated with the image, if any.
The device name of the root device volume (for example, /dev/sda1
).
The type of root device used by the AMI.
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
The current state of the AMI.
The reason for the state change.
Any tags assigned to the image.
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.
The type of virtualization of the AMI.
Deregisters the specified AMI.
Describes the specified attribute of the specified AMI.
Returns true
if this Image exists.
Modifies the specified attribute of the specified AMI.
Resets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
.
Waits until this Image is exists.
add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until
Methods included from Resources::OperationMethods#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations
Constructor Details #initialize(id, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object Instance Attribute Details #architecture ⇒ StringThe architecture of the image.
Possible values:
The date and time the image was created.
#description ⇒ StringThe description of the AMI that was provided during image creation.
#ena_support ⇒ BooleanSpecifies whether enhanced networking with ENA is enabled.
#hypervisor ⇒ StringThe hypervisor type of the image.
Possible values:
The AWS account alias (for example, amazon
, self
) or the AWS account ID of the AMI owner.
The type of image.
Possible values:
The kernel associated with the image, if any. Only applicable for machine images.
#name ⇒ StringThe name of the AMI that was provided during image creation.
#owner_id ⇒ StringThe AWS account ID of the image owner.
#platform ⇒ StringThis value is set to windows
for Windows AMIs; otherwise, it is blank.
Possible values:
The platform details associated with the billing code of the AMI. For more information, see Obtaining Billing Information in the Amazon Elastic Compute Cloud User Guide.
#public ⇒ BooleanIndicates 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.
The RAM disk associated with the image, if any. Only applicable for machine images.
#root_device_name ⇒ StringThe device name of the root device volume (for example, /dev/sda1
).
The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
Possible values:
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
#state ⇒ StringThe current state of the AMI. If the state is available
, the image is successfully registered and can be used to launch an instance.
Possible values:
Any tags assigned to the image.
#usage_operation ⇒ String #virtualization_type ⇒ StringThe type of virtualization of the AMI.
Possible values:
Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
#describe_attribute(options = {}) ⇒ Types::ImageAttributeDescribes the specified attribute of the specified AMI. You can specify only one attribute at a time.
#exists? ⇒ BooleanReturns true
if this Image exists. Returns false
otherwise.
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute
parameter to specify the attribute or one of the following parameters: Description
, LaunchPermission
, or ProductCode
.
AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.
#reset_attribute(options = {}) ⇒ StructResets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
#wait_until_exists {|waiter| ... } ⇒ ImageWaits until this Image is exists. This method waits by polling Client#describe_images until successful. An error is raised after a configurable number of failed checks.
This waiter uses the following defaults:
Configuration Default#delay
15 #max_attempts
40
You can modify defaults and register callbacks by passing a block argument.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4