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

#architectureString

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

Any block device mapping entries.

Returns:



141
142
143
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 141

def block_device_mappings
  data[:block_device_mappings]
end

#boot_modeString

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

Returns:

  • (String)


221
222
223
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 221

def boot_mode
  data[:boot_mode]
end

#clientClient

Returns:



228
229
230
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 228

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:



413
414
415
416
417
418
419
420
421
422
423
424
425
426
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 413

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_dateString

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

#dataTypes::Image

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

Returns:



248
249
250
251
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 248

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.



256
257
258
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 256

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 AWS-generated tags (tags that have the aws: prefix).

Returns:



456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 456

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

#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)


483
484
485
486
487
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 483

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



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

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

#descriptionString

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

Returns:

  • (String)


147
148
149
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 147

def description
  data[:description]
end

#ena_supportBoolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean)


153
154
155
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 153

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.



263
264
265
266
267
268
269
270
271
272
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 263

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

#hypervisorString

The hypervisor type of the image.

Returns:

  • (String)


159
160
161
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 159

def hypervisor
  data[:hypervisor]
end

#idString 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_locationString

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_aliasString

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

Returns:

  • (String)


166
167
168
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 166

def image_owner_alias
  data[:image_owner_alias]
end

#image_typeString

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_idString

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

#loadself 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)


238
239
240
241
242
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 238

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",
      },
    ],
    remove: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
  },
  operation_type: "add", # accepts add, remove
  product_codes: ["String"],
  user_groups: ["String"],
  user_ids: ["String"],
  value: "String",
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :attribute (String)

    The name of the attribute to modify. The valid values are description, launchPermission, and productCodes.

  • :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>)

    The DevPay product codes. After you add a product code to an AMI, it can't be removed.

  • :user_groups (Array<String>)

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

  • :user_ids (Array<String>)

    The AWS 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 or productCodes.

  • :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)


571
572
573
574
575
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 571

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

#nameString

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

Returns:

  • (String)


172
173
174
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 172

def name
  data[:name]
end

#owner_idString

The AWS account ID of the image owner.

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

#platformString

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_detailsString

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.

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

Any product codes associated with the AMI.

Returns:



121
122
123
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 121

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


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

def public
  data[:public]
end

#ramdisk_idString

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

Returns:

  • (String)


128
129
130
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 128

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)


593
594
595
596
597
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 593

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

#root_device_nameString

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

Returns:

  • (String)


178
179
180
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 178

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


185
186
187
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 185

def root_device_type
  data[:root_device_type]
end

#sriov_net_supportString

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

Returns:

  • (String)


192
193
194
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 192

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


135
136
137
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 135

def state
  data[:state]
end

#state_reasonTypes::StateReason

The reason for the state change.

Returns:



198
199
200
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 198

def state_reason
  data[:state_reason]
end

#tagsArray<Types::Tag>

Any tags assigned to the image.

Returns:



204
205
206
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 204

def tags
  data[:tags]
end

#usage_operationString

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 AWS Cost and Usage Report and in the AWS Price List API. For the list of UsageOperation codes, see Platform Details and Usage Operation Billing Codes in the Amazon Elastic Compute Cloud User Guide.

Returns:

  • (String)


115
116
117
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 115

def usage_operation
  data[:usage_operation]
end

#virtualization_typeString

The type of virtualization of the AMI.

Returns:

  • (String)


210
211
212
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 210

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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 372

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:



280
281
282
283
284
285
286
287
288
289
290
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/image.rb', line 280

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