Class: Aws::EC2::Image

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Instance Method Summary collapse

Constructor Details

#initialize(id, options = {}) ⇒ Image #initialize(options = {}) ⇒ Image

Returns a new instance of Image.

Overloads:

  • #initialize(id, options = {}) ⇒ Image

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Image

    Options Hash (options):

    • :id (required, String)
    • :client (Client) 

22
23
24
25
26
27
28
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#architecture ⇒ String

The architecture of the image.

Returns:

  • (String) 

40
41
42
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 40

def architecture
  data[:architecture]
end

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

Any block device mapping entries.

Returns:


144
145
146
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 144

def block_device_mappings
  data[:block_device_mappings]
end

#boot_mode ⇒ String

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

Returns:

  • (String) 

224
225
226
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 224

def boot_mode
  data[:boot_mode]
end

#client ⇒ Client

Returns:


251
252
253
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 251

def client
  @client
end

#create_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tag = image.create_tags({
  dry_run: false,
  tags: [ # required
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :tags (required, Array<Types::Tag>) —

    The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:


436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 436

def create_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = @client.create_tags(options)
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#creation_date ⇒ String

The date and time the image was created.

Returns:

  • (String) 

46
47
48
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 46

def creation_date
  data[:creation_date]
end

#data ⇒ Types::Image

Returns the data for this Aws::EC2::Image. Calls Client#describe_images if #data_loaded? is false.

Returns:


271
272
273
274
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 271

def data
  load unless @data
  @data
end

#data_loaded? ⇒ Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean) —

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.


279
280
281
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 279

def data_loaded?
  !!@data
end

#delete_tags(options = {}) ⇒ Tag::Collection

Examples:

Request syntax with placeholder values


tag = image.delete_tags({
  dry_run: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :tags (Array<Types::Tag>) —

    The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

    If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the aws: prefix).

    Constraints: Up to 1000 tags.

Returns:


481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 481

def delete_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = @client.delete_tags(options)
  options[:tags].each do |t|
    batch << Tag.new(
      resource_id: @id,
      key: t[:key],
      value: t[:value],
      client: @client
    )
  end
  Tag::Collection.new([batch], size: batch.size)
end

#deprecation_time ⇒ String

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DD*T*HH:MM:*SS*Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

Returns:

  • (String) 

244
245
246
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 244

def deprecation_time
  data[:deprecation_time]
end

#deregister(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


image.deregister({
  dry_run: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (EmptyStructure) 

508
509
510
511
512
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 508

def deregister(options = {})
  options = options.merge(image_id: @id)
  resp = @client.deregister_image(options)
  resp.data
end

#describe_attribute(options = {}) ⇒ Types::ImageAttribute

Examples:

Request syntax with placeholder values


image.describe_attribute({
  attribute: "description", # required, accepts description, kernel, ramdisk, launchPermission, productCodes, blockDeviceMapping, sriovNetSupport, bootMode, tpmSupport, uefiData, lastLaunchedTime
  dry_run: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :attribute (required, String) —

    The AMI attribute.

    Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:


534
535
536
537
538
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 534

def describe_attribute(options = {})
  options = options.merge(image_id: @id)
  resp = @client.describe_image_attribute(options)
  resp.data
end

#description ⇒ String

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

Returns:

  • (String) 

150
151
152
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 150

def description
  data[:description]
end

#ena_support ⇒ Boolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean) 

156
157
158
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 156

def ena_support
  data[:ena_support]
end

#exists?(options = {}) ⇒ Boolean

Returns true if the Image exists.

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Boolean) —

    Returns true if the Image exists.


286
287
288
289
290
291
292
293
294
295
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 286

def exists?(options = {})
  begin
    wait_until_exists(options.merge(max_attempts: 1))
    true
  rescue Aws::Waiters::Errors::UnexpectedError => e
    raise e.error
  rescue Aws::Waiters::Errors::WaiterFailed
    false
  end
end

#hypervisor ⇒ String

The hypervisor type of the image.

Returns:

  • (String) 

162
163
164
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 162

def hypervisor
  data[:hypervisor]
end

#id ⇒ String Also known as: image_id

Returns:

  • (String) 

33
34
35
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 33

def id
  @id
end

#image_location ⇒ String

The location of the AMI.

Returns:

  • (String) 

52
53
54
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 52

def image_location
  data[:image_location]
end

#image_owner_alias ⇒ String

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

Returns:

  • (String) 

169
170
171
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 169

def image_owner_alias
  data[:image_owner_alias]
end

#image_type ⇒ String

The type of image.

Returns:

  • (String) 

58
59
60
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 58

def image_type
  data[:image_type]
end

#kernel_id ⇒ String

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

Returns:

  • (String) 

73
74
75
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 73

def kernel_id
  data[:kernel_id]
end

#load ⇒ self Also known as: reload

Loads, or reloads #data for the current Aws::EC2::Image. Returns self making it possible to chain methods.

image.reload.data

Returns:

  • (self) 

261
262
263
264
265
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 261

def load
  resp = @client.describe_images(image_ids: [@id])
  @data = resp.images[0]
  self
end

#modify_attribute(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


image.modify_attribute({
  attribute: "String",
  description: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  launch_permission: {
    add: [
      {
        group: "all", # accepts all
        user_id: "String",
        organization_arn: "String",
        organizational_unit_arn: "String",
      },
    ],
    remove: [
      {
        group: "all", # accepts all
        user_id: "String",
        organization_arn: "String",
        organizational_unit_arn: "String",
      },
    ],
  },
  operation_type: "add", # accepts add, remove
  product_codes: ["String"],
  user_groups: ["String"],
  user_ids: ["String"],
  value: "String",
  dry_run: false,
  organization_arns: ["String"],
  organizational_unit_arns: ["String"],
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :attribute (String) —

    The name of the attribute to modify.

    Valid values: description | launchPermission

  • :description (Types::AttributeValue) —

    A new description for the AMI.

  • :launch_permission (Types::LaunchPermissionModifications) —

    A new launch permission for the AMI.

  • :operation_type (String) —

    The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

  • :product_codes (Array<String>) —

    Not supported.

  • :user_groups (Array<String>) —

    The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

  • :user_ids (Array<String>) —

    The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

  • :value (String) —

    The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description.

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • :organization_arns (Array<String>) —

    The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

  • :organizational_unit_arns (Array<String>) —

    The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (EmptyStructure) 

608
609
610
611
612
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 608

def modify_attribute(options = {})
  options = options.merge(image_id: @id)
  resp = @client.modify_image_attribute(options)
  resp.data
end

#name ⇒ String

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

Returns:

  • (String) 

175
176
177
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 175

def name
  data[:name]
end

#owner_id ⇒ String

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

Returns:

  • (String) 

79
80
81
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 79

def owner_id
  data[:owner_id]
end

#platform ⇒ String

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

Returns:

  • (String) 

86
87
88
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 86

def platform
  data[:platform]
end

#platform_details ⇒ String

The platform details associated with the billing code of the AMI. For more information, see Understanding AMI billing in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String) 

98
99
100
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 98

def platform_details
  data[:platform_details]
end

#product_codes ⇒ Array<Types::ProductCode>

Any product codes associated with the AMI.

Returns:


124
125
126
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 124

def product_codes
  data[:product_codes]
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) 

66
67
68
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 66

def public
  data[:public]
end

#ramdisk_id ⇒ String

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

Returns:

  • (String) 

131
132
133
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 131

def ramdisk_id
  data[:ramdisk_id]
end

#reset_attribute(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


image.reset_attribute({
  attribute: "launchPermission", # required, accepts launchPermission
  dry_run: false,
})

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :attribute (required, String) —

    The attribute to reset (currently you can only reset the launch permission attribute).

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

  • (EmptyStructure) 

630
631
632
633
634
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 630

def reset_attribute(options = {})
  options = options.merge(image_id: @id)
  resp = @client.reset_image_attribute(options)
  resp.data
end

#root_device_name ⇒ String

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

Returns:

  • (String) 

181
182
183
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 181

def root_device_name
  data[:root_device_name]
end

#root_device_type ⇒ String

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

Returns:

  • (String) 

188
189
190
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 188

def root_device_type
  data[:root_device_type]
end

#sriov_net_support ⇒ String

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

Returns:

  • (String) 

195
196
197
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 195

def sriov_net_support
  data[:sriov_net_support]
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) 

138
139
140
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 138

def state
  data[:state]
end

#state_reason ⇒ Types::StateReason

The reason for the state change.

Returns:


201
202
203
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 201

def state_reason
  data[:state_reason]
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the image.

Returns:


207
208
209
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 207

def tags
  data[:tags]
end

#tpm_support ⇒ String

If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String) 

236
237
238
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 236

def tpm_support
  data[:tpm_support]
end

#usage_operation ⇒ String

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.

Returns:

  • (String) 

118
119
120
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 118

def usage_operation
  data[:usage_operation]
end

#virtualization_type ⇒ String

The type of virtualization of the AMI.

Returns:

  • (String) 

213
214
215
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 213

def virtualization_type
  data[:virtualization_type]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::EC2::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not


395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 395

def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end

#wait_until_exists(options = {}, &block) ⇒ Image

Parameters:

  • options (Hash) (defaults to: {}) —

    ({})

Options Hash (options):

  • :max_attempts (Integer) — default: 40
  • :delay (Float) — default: 15
  • :before_attempt (Proc)
  • :before_wait (Proc)

Returns:


303
304
305
306
307
308
309
310
311
312
313
 
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 303

def wait_until_exists(options = {}, &block)
  options, params = separate_params_and_options(options)
  waiter = Waiters::ImageExists.new(options)
  yield_waiter_and_warn(waiter, &block) if block_given?
  resp = waiter.wait(params.merge(image_ids: [@id]))
  Image.new({
    id: @id,
    data: resp.data.images[0],
    client: @client
  })
end