Class: Aws::EC2::Instance

Inherits:
Object
  • Object
show all
Extended by:
Deprecations
Defined in:
lib/aws-sdk-ec2/customizations/instance.rb,
lib/aws-sdk-ec2/instance.rb

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Actions collapse

Associations collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Instance.

Overloads:

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

    Parameters:

    • id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ Instance

    Options Hash (options):

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


19
20
21
22
23
24
 
# File 'lib/aws-sdk-ec2/instance.rb', line 19

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

Instance Method Details

#ami_launch_index ⇒ Integer

The AMI launch index, which can be used to find this instance in the launch group.

Returns:

  • (Integer) 


37
38
39
 
# File 'lib/aws-sdk-ec2/instance.rb', line 37

def ami_launch_index
  data[:ami_launch_index]
end

#architecture ⇒ String

The architecture of the image.

Returns:

  • (String) 


164
165
166
 
# File 'lib/aws-sdk-ec2/instance.rb', line 164

def architecture
  data[:architecture]
end

#attach_classic_link_vpc(options = {}) ⇒ Types::AttachClassicLinkVpcResult

Examples:

Request syntax with placeholder values


instance.attach_classic_link_vpc({
  dry_run: false,
  groups: ["String"], # required
  vpc_id: "String", # required
})

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`.

  • :groups (required, Array<String>) —

    The ID of one or more of the VPC’s security groups. You cannot specify security groups from a different VPC.

  • :vpc_id (required, String) —

    The ID of a ClassicLink-enabled VPC.

Returns:



559
560
561
562
563
 
# File 'lib/aws-sdk-ec2/instance.rb', line 559

def attach_classic_link_vpc(options = {})
  options = options.merge(instance_id: @id)
  resp = @client.attach_classic_link_vpc(options)
  resp.data
end

#attach_volume(options = {}) ⇒ Types::VolumeAttachment

Examples:

Request syntax with placeholder values


instance.attach_volume({
  device: "String", # required
  volume_id: "String", # required
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :device (required, String) —

    The device name (for example, ‘/dev/sdh` or `xvdh`).

  • :volume_id (required, String) —

    The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

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



584
585
586
587
588
 
# File 'lib/aws-sdk-ec2/instance.rb', line 584

def attach_volume(options = {})
  options = options.merge(instance_id: @id)
  resp = @client.attach_volume(options)
  resp.data
end

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

Any block device mapping entries for the instance.

Returns:



170
171
172
 
# File 'lib/aws-sdk-ec2/instance.rb', line 170

def block_device_mappings
  data[:block_device_mappings]
end

#capacity_reservation_id ⇒ String

The ID of the Capacity Reservation.

Returns:

  • (String) 


300
301
302
 
# File 'lib/aws-sdk-ec2/instance.rb', line 300

def capacity_reservation_id
  data[:capacity_reservation_id]
end

#capacity_reservation_specification ⇒ Types::CapacityReservationSpecificationResponse

Information about the Capacity Reservation targeting option.

Returns:



306
307
308
 
# File 'lib/aws-sdk-ec2/instance.rb', line 306

def capacity_reservation_specification
  data[:capacity_reservation_specification]
end

#classic_address ⇒ ClassicAddress?

Returns:



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1225

def classic_address
  if data[:public_ip_address]
    ClassicAddress.new(
      public_ip: data[:public_ip_address],
      client: @client
    )
  else
    nil
  end
end

#client ⇒ Client

Returns:



325
326
327
 
# File 'lib/aws-sdk-ec2/instance.rb', line 325

def client
  @client
end

#client_token ⇒ String

The idempotency token you provided when you launched the instance, if applicable.

Returns:

  • (String) 


177
178
179
 
# File 'lib/aws-sdk-ec2/instance.rb', line 177

def client_token
  data[:client_token]
end

#console_output(options = {}) ⇒ Types::GetConsoleOutputResult

Examples:

Request syntax with placeholder values


instance.console_output({
  dry_run: false,
  latest: 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`.

  • :latest (Boolean) —

    When enabled, retrieves the latest console output for the instance.

    Default: disabled (‘false`)

Returns:



607
608
609
610
611
 
# File 'lib/aws-sdk-ec2/instance.rb', line 607

def console_output(options = {})
  options = options.merge(instance_id: @id)
  resp = @client.get_console_output(options)
  resp.data
end

#cpu_options ⇒ Types::CpuOptions

The CPU options for the instance.

Returns:



294
295
296
 
# File 'lib/aws-sdk-ec2/instance.rb', line 294

def cpu_options
  data[:cpu_options]
end

#create_image(options = {}) ⇒ Image

Examples:

Request syntax with placeholder values


image = instance.create_image({
  block_device_mappings: [
    {
      device_name: "String",
      virtual_name: "String",
      ebs: {
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "String",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, gp2, sc1, st1
        encrypted: false,
        kms_key_id: "String",
      },
      no_device: "String",
    },
  ],
  description: "String",
  dry_run: false,
  name: "String", # required
  no_reboot: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :block_device_mappings (Array<Types::BlockDeviceMapping>) —

    Information about one or more block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

  • :description (String) —

    A description for the new image.

  • :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`.

  • :name (required, String) —

    A name for the new image.

    Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (‘), at-signs (@), or underscores(_)

  • :no_reboot (Boolean) —

    By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the ‘No Reboot’ option is set, Amazon EC2 doesn’t shut down the instance before creating the image. When this option is used, file system integrity on the created image can’t be guaranteed.

Returns:



663
664
665
666
667
668
669
670
 
# File 'lib/aws-sdk-ec2/instance.rb', line 663

def create_image(options = {})
  options = options.merge(instance_id: @id)
  resp = @client.create_image(options)
  Image.new(
    id: resp.data.image_id,
    client: @client
  )
end

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

Examples:

Request syntax with placeholder values


tag = instance.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>) —

    One or more 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:



694
695
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/aws-sdk-ec2/instance.rb', line 694

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

#data ⇒ Types::Instance

Returns the data for this Aws::EC2::Instance. Calls Client#describe_instances if #data_loaded? is ‘false`.

Returns:



345
346
347
348
 
# File 'lib/aws-sdk-ec2/instance.rb', line 345

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.



353
354
355
 
# File 'lib/aws-sdk-ec2/instance.rb', line 353

def data_loaded?
  !!@data
end

#decrypt_windows_password(key_pair_path) ⇒ String

Parameters:

  • key_pair_path (String, Pathname)

Returns:

  • (String) 


9
10
11
12
13
14
 
# File 'lib/aws-sdk-ec2/customizations/instance.rb', line 9

def decrypt_windows_password(key_pair_path)
  decoded = Base64.decode64(encrypted_password)
  pem_bytes = File.open(key_pair_path, 'rb') { |f| f.read }
  private_key = OpenSSL::PKey::RSA.new(pem_bytes)
  private_key.private_decrypt(decoded)
end

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

Examples:

Request syntax with placeholder values


instance.describe_attribute({
  attribute: "instanceType", # required, accepts instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport, enaSupport
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :attribute (required, String) —

    The instance attribute.

    Note: The ‘enaSupport` attribute is not supported at this time.

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



726
727
728
729
730
 
# File 'lib/aws-sdk-ec2/instance.rb', line 726

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

#detach_classic_link_vpc(options = {}) ⇒ Types::DetachClassicLinkVpcResult

Examples:

Request syntax with placeholder values


instance.detach_classic_link_vpc({
  dry_run: false,
  vpc_id: "String", # required
})

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`.

  • :vpc_id (required, String) —

    The ID of the VPC to which the instance is linked.

Returns:



747
748
749
750
751
 
# File 'lib/aws-sdk-ec2/instance.rb', line 747

def detach_classic_link_vpc(options = {})
  options = options.merge(instance_id: @id)
  resp = @client.detach_classic_link_vpc(options)
  resp.data
end

#detach_volume(options = {}) ⇒ Types::VolumeAttachment

Examples:

Request syntax with placeholder values


instance.detach_volume({
  device: "String",
  force: false,
  volume_id: "String", # required
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :device (String) —

    The device name.

  • :force (Boolean) —

    Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won’t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

  • :volume_id (required, String) —

    The ID of the volume.

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



781
782
783
784
785
 
# File 'lib/aws-sdk-ec2/instance.rb', line 781

def detach_volume(options = {})
  options = options.merge(instance_id: @id)
  resp = @client.detach_volume(options)
  resp.data
end

#ebs_optimized ⇒ Boolean

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/aws-sdk-ec2/instance.rb', line 187

def ebs_optimized
  data[:ebs_optimized]
end

#elastic_gpu_associations ⇒ Array<Types::ElasticGpuAssociation>

The Elastic GPU associated with the instance.

Returns:



217
218
219
 
# File 'lib/aws-sdk-ec2/instance.rb', line 217

def elastic_gpu_associations
  data[:elastic_gpu_associations]
end

#elastic_inference_accelerator_associations ⇒ Array<Types::ElasticInferenceAcceleratorAssociation>

The elastic inference accelerator associated with the instance.

Returns:



223
224
225
 
# File 'lib/aws-sdk-ec2/instance.rb', line 223

def elastic_inference_accelerator_associations
  data[:elastic_inference_accelerator_associations]
end

#ena_support ⇒ Boolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean) 


193
194
195
 
# File 'lib/aws-sdk-ec2/instance.rb', line 193

def ena_support
  data[:ena_support]
end

#exists?(options = {}) ⇒ Boolean

Returns ‘true` if the Instance exists.

Parameters:

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

    ({})

Returns:

  • (Boolean) —

    Returns ‘true` if the Instance exists.



360
361
362
363
364
365
366
367
368
369
 
# File 'lib/aws-sdk-ec2/instance.rb', line 360

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

#hibernation_options ⇒ Types::HibernationOptions

Indicates whether the instance is enabled for hibernation.

Returns:



312
313
314
 
# File 'lib/aws-sdk-ec2/instance.rb', line 312

def hibernation_options
  data[:hibernation_options]
end

#hypervisor ⇒ String

The hypervisor type of the instance.

Returns:

  • (String) 


199
200
201
 
# File 'lib/aws-sdk-ec2/instance.rb', line 199

def hypervisor
  data[:hypervisor]
end

#iam_instance_profile ⇒ Types::IamInstanceProfile

The IAM instance profile associated with the instance, if applicable.

Returns:



205
206
207
 
# File 'lib/aws-sdk-ec2/instance.rb', line 205

def iam_instance_profile
  data[:iam_instance_profile]
end

#id ⇒ String Also known as: instance_id

Returns:

  • (String) 


29
30
31
 
# File 'lib/aws-sdk-ec2/instance.rb', line 29

def id
  @id
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1482
1483
1484
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1482

def identifiers
  { id: @id }
end

#image ⇒ Image?

Returns:



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1237

def image
  if data[:image_id]
    Image.new(
      id: data[:image_id],
      client: @client
    )
  else
    nil
  end
end

#image_id ⇒ String

The ID of the AMI used to launch the instance.

Returns:

  • (String) 


43
44
45
 
# File 'lib/aws-sdk-ec2/instance.rb', line 43

def image_id
  data[:image_id]
end

#instance_lifecycle ⇒ String

Indicates whether this is a Spot Instance or a Scheduled Instance.

Returns:

  • (String) 


211
212
213
 
# File 'lib/aws-sdk-ec2/instance.rb', line 211

def instance_lifecycle
  data[:instance_lifecycle]
end

#instance_type ⇒ String

The instance type.

Returns:

  • (String) 


49
50
51
 
# File 'lib/aws-sdk-ec2/instance.rb', line 49

def instance_type
  data[:instance_type]
end

#kernel_id ⇒ String

The kernel associated with this instance, if applicable.

Returns:

  • (String) 


55
56
57
 
# File 'lib/aws-sdk-ec2/instance.rb', line 55

def kernel_id
  data[:kernel_id]
end

#key_name ⇒ String

The name of the key pair, if this instance was launched with an associated key pair.

Returns:

  • (String) 


62
63
64
 
# File 'lib/aws-sdk-ec2/instance.rb', line 62

def key_name
  data[:key_name]
end

#key_pair ⇒ KeyPairInfo?

Returns:



1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1249

def key_pair
  if data[:key_name]
    KeyPairInfo.new(
      name: data[:key_name],
      client: @client
    )
  else
    nil
  end
end

#launch_time ⇒ Time

The time the instance was launched.

Returns:

  • (Time) 


68
69
70
 
# File 'lib/aws-sdk-ec2/instance.rb', line 68

def launch_time
  data[:launch_time]
end

#licenses ⇒ Array<Types::LicenseConfiguration>

The license configurations.

Returns:



318
319
320
 
# File 'lib/aws-sdk-ec2/instance.rb', line 318

def licenses
  data[:licenses]
end

#load ⇒ self Also known as: reload

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

instance.reload.data

Returns:

  • (self) 


335
336
337
338
339
 
# File 'lib/aws-sdk-ec2/instance.rb', line 335

def load
  resp = @client.describe_instances(instance_ids: [@id])
  @data = resp.reservations[0].instances[0]
  self
end

#modify_attribute(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.modify_attribute({
  source_dest_check: {
    value: false,
  },
  attribute: "instanceType", # accepts instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport, enaSupport
  block_device_mappings: [
    {
      device_name: "String",
      ebs: {
        delete_on_termination: false,
        volume_id: "String",
      },
      no_device: "String",
      virtual_name: "String",
    },
  ],
  disable_api_termination: {
    value: false,
  },
  dry_run: false,
  ebs_optimized: {
    value: false,
  },
  ena_support: {
    value: false,
  },
  groups: ["String"],
  instance_initiated_shutdown_behavior: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  instance_type: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  kernel: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  ramdisk: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  sriov_net_support: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  user_data: {
    value: "data",
  },
  value: "String",
})

Parameters:

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

    ({})

Options Hash (options):

  • :source_dest_check (Types::AttributeBooleanValue) —

    Specifies whether source/destination checking is enabled. A value of ‘true` means that checking is enabled, and `false` means that checking is disabled. This value must be `false` for a NAT instance to perform NAT.

  • :attribute (String) —

    The name of the attribute.

  • :block_device_mappings (Array<Types::InstanceBlockDeviceMappingSpecification>) —

    Modifies the ‘DeleteOnTermination` attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for `DeleteOnTermination`, the default is `true` and the volume is deleted when the instance is terminated.

    To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see

    Updating the Block Device Mapping when Launching an Instance][1

    in

    the *Amazon Elastic Compute Cloud User Guide*.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM

  • :disable_api_termination (Types::AttributeBooleanValue) —

    If the value is ‘true`, you can’t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.

  • :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`.

  • :ebs_optimized (Types::AttributeBooleanValue) —

    Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn’t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

  • :ena_support (Types::AttributeBooleanValue) —

    Set to ‘true` to enable enhanced networking with ENA for the instance.

    This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

  • :groups (Array<String>) —

    [EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it’s just the default security group for the VPC. You must specify the security group ID, not the security group name.

  • :instance_initiated_shutdown_behavior (Types::AttributeValue) —

    Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

  • :instance_type (Types::AttributeValue) —

    Changes the instance type to the specified value. For more information, see [Instance Types]. If the instance type is not valid, the error returned is ‘InvalidInstanceAttributeValue`.

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html

  • :kernel (Types::AttributeValue) —

    Changes the instance’s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html

  • :ramdisk (Types::AttributeValue) —

    Changes the instance’s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html

  • :sriov_net_support (Types::AttributeValue) —

    Set to ‘simple` to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

    There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

    This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

  • :user_data (Types::BlobAttributeValue) —

    Changes the instance’s user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.

  • :value (String) —

    A new value for the attribute. Use only with the ‘kernel`, `ramdisk`, `userData`, `disableApiTermination`, or `instanceInitiatedShutdownBehavior` attribute.

Returns:

  • (EmptyStructure) 


920
921
922
923
924
 
# File 'lib/aws-sdk-ec2/instance.rb', line 920

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

#monitor(options = {}) ⇒ Types::MonitorInstancesResult

Examples:

Request syntax with placeholder values


instance.monitor({
  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:



938
939
940
941
942
 
# File 'lib/aws-sdk-ec2/instance.rb', line 938

def monitor(options = {})
  options = Aws::Util.deep_merge(options, instance_ids: [@id])
  resp = @client.monitor_instances(options)
  resp.data
end

#monitoring ⇒ Types::Monitoring

The monitoring for the instance.

Returns:



74
75
76
 
# File 'lib/aws-sdk-ec2/instance.rb', line 74

def monitoring
  data[:monitoring]
end

#network_interfaces ⇒ NetworkInterface::Collection

Returns:



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1261

def network_interfaces
  batch = []
  data[:network_interfaces].each do |d|
    batch << NetworkInterface.new(
      id: d[:network_interface_id],
      data: d,
      client: @client
    )
  end
  NetworkInterface::Collection.new([batch], size: batch.size)
end

#password_data(options = {}) ⇒ Types::GetPasswordDataResult

Examples:

Request syntax with placeholder values


instance.password_data({
  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:



956
957
958
959
960
 
# File 'lib/aws-sdk-ec2/instance.rb', line 956

def password_data(options = {})
  options = options.merge(instance_id: @id)
  resp = @client.get_password_data(options)
  resp.data
end

#placement ⇒ Types::Placement

The location where the instance launched, if applicable.

Returns:



80
81
82
 
# File 'lib/aws-sdk-ec2/instance.rb', line 80

def placement
  data[:placement]
end

#placement_group ⇒ PlacementGroup?

Returns:



1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1274

def placement_group
  if data[:placement][:group_name]
    PlacementGroup.new(
      name: data[:placement][:group_name],
      client: @client
    )
  else
    nil
  end
end

#platform ⇒ String

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

Returns:

  • (String) 


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

def platform
  data[:platform]
end

#private_dns_name ⇒ String

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the ‘running` state.

[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you’ve enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

Returns:

  • (String) 


100
101
102
 
# File 'lib/aws-sdk-ec2/instance.rb', line 100

def private_dns_name
  data[:private_dns_name]
end

#private_ip_address ⇒ String

The private IPv4 address assigned to the instance.

Returns:

  • (String) 


106
107
108
 
# File 'lib/aws-sdk-ec2/instance.rb', line 106

def private_ip_address
  data[:private_ip_address]
end

#product_codes ⇒ Array<Types::ProductCode>

The product codes attached to this instance, if applicable.

Returns:



112
113
114
 
# File 'lib/aws-sdk-ec2/instance.rb', line 112

def product_codes
  data[:product_codes]
end

#public_dns_name ⇒ String

(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the ‘running` state. For EC2-VPC, this name is only available if you’ve enabled DNS hostnames for your VPC.

Returns:

  • (String) 


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

def public_dns_name
  data[:public_dns_name]
end

#public_ip_address ⇒ String

The public IPv4 address assigned to the instance, if applicable.

Returns:

  • (String) 


127
128
129
 
# File 'lib/aws-sdk-ec2/instance.rb', line 127

def public_ip_address
  data[:public_ip_address]
end

#ramdisk_id ⇒ String

The RAM disk associated with this instance, if applicable.

Returns:

  • (String) 


133
134
135
 
# File 'lib/aws-sdk-ec2/instance.rb', line 133

def ramdisk_id
  data[:ramdisk_id]
end

#reboot(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.reboot({
  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) 


974
975
976
977
978
 
# File 'lib/aws-sdk-ec2/instance.rb', line 974

def reboot(options = {})
  options = Aws::Util.deep_merge(options, instance_ids: [@id])
  resp = @client.reboot_instances(options)
  resp.data
end

#report_status(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.report_status({
  description: "String",
  dry_run: false,
  end_time: Time.now,
  reason_codes: ["instance-stuck-in-state"], # required, accepts instance-stuck-in-state, unresponsive, not-accepting-credentials, password-not-available, performance-network, performance-instance-store, performance-ebs-volume, performance-other, other
  start_time: Time.now,
  status: "ok", # required, accepts ok, impaired
})

Parameters:

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

    ({})

Options Hash (options):

  • :description (String) —

    Descriptive text about the health state of your instance.

  • :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`.

  • :end_time (Time, DateTime, Date, Integer, String) —

    The time at which the reported instance health state ended.

  • :reason_codes (required, Array<String>) —

    One or more reason codes that describe the health state of your instance.

    • ‘instance-stuck-in-state`: My instance is stuck in a state.

    • ‘unresponsive`: My instance is unresponsive.

    • ‘not-accepting-credentials`: My instance is not accepting my credentials.

    • ‘password-not-available`: A password is not available for my instance.

    • ‘performance-network`: My instance is experiencing performance problems that I believe are network related.

    • ‘performance-instance-store`: My instance is experiencing performance problems that I believe are related to the instance stores.

    • ‘performance-ebs-volume`: My instance is experiencing performance problems that I believe are related to an EBS volume.

    • ‘performance-other`: My instance is experiencing performance problems.

    • ‘other`: [explain using the description parameter]

  • :start_time (Time, DateTime, Date, Integer, String) —

    The time at which the reported instance health state began.

  • :status (required, String) —

    The status of all instances listed.

Returns:

  • (EmptyStructure) 


1033
1034
1035
1036
1037
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1033

def report_status(options = {})
  options = Aws::Util.deep_merge(options, instances: [@id])
  resp = @client.report_instance_status(options)
  resp.data
end

#reset_attribute(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.reset_attribute({
  attribute: "instanceType", # required, accepts instanceType, kernel, ramdisk, userData, disableApiTermination, instanceInitiatedShutdownBehavior, rootDeviceName, blockDeviceMapping, productCodes, sourceDestCheck, groupSet, ebsOptimized, sriovNetSupport, enaSupport
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :attribute (required, String) —

    The attribute to reset.

    You can only reset the following attributes: ‘kernel` | `ramdisk` | `sourceDestCheck`. To change an instance attribute, use ModifyInstanceAttribute.

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


1058
1059
1060
1061
1062
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1058

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

#reset_kernel(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.reset_kernel({
  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) 


1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1076

def reset_kernel(options = {})
  options = options.merge(
    instance_id: @id,
    attribute: "kernel"
  )
  resp = @client.reset_instance_attribute(options)
  resp.data
end

#reset_ramdisk(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.reset_ramdisk({
  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) 


1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1097

def reset_ramdisk(options = {})
  options = options.merge(
    instance_id: @id,
    attribute: "ramdisk"
  )
  resp = @client.reset_instance_attribute(options)
  resp.data
end

#reset_source_dest_check(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.reset_source_dest_check({
  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) 


1118
1119
1120
1121
1122
1123
1124
1125
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1118

def reset_source_dest_check(options = {})
  options = options.merge(
    instance_id: @id,
    attribute: "sourceDestCheck"
  )
  resp = @client.reset_instance_attribute(options)
  resp.data
end

#root_device_name ⇒ String

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

Returns:

  • (String) 


229
230
231
 
# File 'lib/aws-sdk-ec2/instance.rb', line 229

def root_device_name
  data[:root_device_name]
end

#root_device_type ⇒ String

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

Returns:

  • (String) 


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

def root_device_type
  data[:root_device_type]
end

#security_groups ⇒ Array<Types::GroupIdentifier>

One or more security groups for the instance.

Returns:



242
243
244
 
# File 'lib/aws-sdk-ec2/instance.rb', line 242

def security_groups
  data[:security_groups]
end

#source_dest_check ⇒ Boolean

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of ‘true` means that checking is enabled, and `false` means that checking is disabled. The value must be `false` for the instance to perform NAT. For more information, see [NAT Instances] in the *Amazon Virtual Private Cloud User Guide*.

[1]: docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html

Returns:

  • (Boolean) 


257
258
259
 
# File 'lib/aws-sdk-ec2/instance.rb', line 257

def source_dest_check
  data[:source_dest_check]
end

#spot_instance_request_id ⇒ String

If the request is a Spot Instance request, the ID of the request.

Returns:

  • (String) 


263
264
265
 
# File 'lib/aws-sdk-ec2/instance.rb', line 263

def spot_instance_request_id
  data[:spot_instance_request_id]
end

#sriov_net_support ⇒ String

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

Returns:

  • (String) 


270
271
272
 
# File 'lib/aws-sdk-ec2/instance.rb', line 270

def sriov_net_support
  data[:sriov_net_support]
end

#start(options = {}) ⇒ Types::StartInstancesResult

Examples:

Request syntax with placeholder values


instance.start({
  additional_info: "String",
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :additional_info (String) —

    Reserved.

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



1142
1143
1144
1145
1146
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1142

def start(options = {})
  options = Aws::Util.deep_merge(options, instance_ids: [@id])
  resp = @client.start_instances(options)
  resp.data
end

#state ⇒ Types::InstanceState

The current state of the instance.

Returns:



139
140
141
 
# File 'lib/aws-sdk-ec2/instance.rb', line 139

def state
  data[:state]
end

#state_reason ⇒ Types::StateReason

The reason for the most recent state transition.

Returns:



276
277
278
 
# File 'lib/aws-sdk-ec2/instance.rb', line 276

def state_reason
  data[:state_reason]
end

#state_transition_reason ⇒ String

The reason for the most recent state transition. This might be an empty string.

Returns:

  • (String) 


146
147
148
 
# File 'lib/aws-sdk-ec2/instance.rb', line 146

def state_transition_reason
  data[:state_transition_reason]
end

#stop(options = {}) ⇒ Types::StopInstancesResult

Examples:

Request syntax with placeholder values


instance.stop({
  hibernate: false,
  dry_run: false,
  force: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :hibernate (Boolean) —

    Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see [Hibernate Your Instance] in the *Amazon Elastic Compute Cloud User Guide*.

    Default: ‘false`

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html

  • :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`.

  • :force (Boolean) —

    Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

    Default: ‘false`

Returns:



1180
1181
1182
1183
1184
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1180

def stop(options = {})
  options = Aws::Util.deep_merge(options, instance_ids: [@id])
  resp = @client.stop_instances(options)
  resp.data
end

#subnet ⇒ Subnet?

Returns:



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1286

def subnet
  if data[:subnet_id]
    Subnet.new(
      id: data[:subnet_id],
      client: @client
    )
  else
    nil
  end
end

#subnet_id ⇒ String

[EC2-VPC] The ID of the subnet in which the instance is running.

Returns:

  • (String) 


152
153
154
 
# File 'lib/aws-sdk-ec2/instance.rb', line 152

def subnet_id
  data[:subnet_id]
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the instance.

Returns:



282
283
284
 
# File 'lib/aws-sdk-ec2/instance.rb', line 282

def tags
  data[:tags]
end

#terminate(options = {}) ⇒ Types::TerminateInstancesResult

Examples:

Request syntax with placeholder values


instance.terminate({
  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:



1198
1199
1200
1201
1202
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1198

def terminate(options = {})
  options = Aws::Util.deep_merge(options, instance_ids: [@id])
  resp = @client.terminate_instances(options)
  resp.data
end

#unmonitor(options = {}) ⇒ Types::UnmonitorInstancesResult

Examples:

Request syntax with placeholder values


instance.unmonitor({
  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:



1216
1217
1218
1219
1220
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1216

def unmonitor(options = {})
  options = Aws::Util.deep_merge(options, instance_ids: [@id])
  resp = @client.unmonitor_instances(options)
  resp.data
end

#virtualization_type ⇒ String

The virtualization type of the instance.

Returns:

  • (String) 


288
289
290
 
# File 'lib/aws-sdk-ec2/instance.rb', line 288

def virtualization_type
  data[:virtualization_type]
end

#volumes(options = {}) ⇒ Volume::Collection

Examples:

Request syntax with placeholder values


volumes = instance.volumes({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  volume_ids: ["String"],
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :filters (Array<Types::Filter>) —

    One or more filters.

    • ‘attachment.attach-time` - The time stamp when the attachment initiated.

    • ‘attachment.delete-on-termination` - Whether the volume is deleted on instance termination.

    • ‘attachment.device` - The device name specified in the block device mapping (for example, `/dev/sda1`).

    • ‘attachment.instance-id` - The ID of the instance the volume is attached to.

    • ‘attachment.status` - The attachment state (`attaching` | `attached` | `detaching`).

    • ‘availability-zone` - The Availability Zone in which the volume was created.

    • ‘create-time` - The time stamp when the volume was created.

    • ‘encrypted` - The encryption status of the volume.

    • ‘size` - The size of the volume, in GiB.

    • ‘snapshot-id` - The snapshot from which the volume was created.

    • ‘status` - The status of the volume (`creating` | `available` | `in-use` | `deleting` | `deleted` | `error`).

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

    • ‘volume-id` - The volume ID.

    • ‘volume-type` - The Amazon EBS volume type. This can be `gp2` for General Purpose SSD, `io1` for Provisioned IOPS SSD, `st1` for Throughput Optimized HDD, `sc1` for Cold HDD, or `standard` for Magnetic volumes.

  • :volume_ids (Array<String>) —

    One or more volume IDs.

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



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1366

def volumes(options = {})
  batches = Enumerator.new do |y|
    options = Aws::Util.deep_merge(options, filters: [{
      name: "attachment.instance-id",
      values: [@id]
    }])
    resp = @client.describe_volumes(options)
    resp.each_page do |page|
      batch = []
      page.data.volumes.each do |v|
        batch << Volume.new(
          id: v.volume_id,
          data: v,
          client: @client
        )
      end
      y.yield(batch)
    end
  end
  Volume::Collection.new(batches)
end

#vpc ⇒ Vpc?

Returns:



1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1389

def vpc
  if data[:vpc_id]
    Vpc.new(
      id: data[:vpc_id],
      client: @client
    )
  else
    nil
  end
end

#vpc_addresses(options = {}) ⇒ VpcAddress::Collection

Examples:

Request syntax with placeholder values


vpc_addresses = instance.vpc_addresses({
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  public_ips: ["String"],
  allocation_ids: ["String"],
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :filters (Array<Types::Filter>) —

    One or more filters. Filter names and values are case-sensitive.

    • ‘allocation-id` - [EC2-VPC] The allocation ID for the address.

    • ‘association-id` - [EC2-VPC] The association ID for the address.

    • ‘domain` - Indicates whether the address is for use in EC2-Classic (`standard`) or in a VPC (`vpc`).

    • ‘instance-id` - The ID of the instance the address is associated with, if any.

    • ‘network-interface-id` - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

    • ‘network-interface-owner-id` - The AWS account ID of the owner.

    • ‘private-ip-address` - [EC2-VPC] The private IP address associated with the Elastic IP address.

    • ‘public-ip` - The Elastic IP address.

    • ‘tag`:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value.

    • ‘tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • :public_ips (Array<String>) —

    One or more Elastic IP addresses.

    Default: Describes all your Elastic IP addresses.

  • :allocation_ids (Array<String>) —

    [EC2-VPC] One or more allocation IDs.

    Default: Describes all your Elastic IP addresses.

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



1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1460

def vpc_addresses(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = Aws::Util.deep_merge(options, filters: [{
      name: "instance-id",
      values: [@id]
    }])
    resp = @client.describe_addresses(options)
    resp.data.addresses.each do |a|
      batch << VpcAddress.new(
        allocation_id: a.allocation_id,
        data: a,
        client: @client
      )
    end
    y.yield(batch)
  end
  VpcAddress::Collection.new(batches)
end

#vpc_id ⇒ String

[EC2-VPC] The ID of the VPC in which the instance is running.

Returns:

  • (String) 


158
159
160
 
# File 'lib/aws-sdk-ec2/instance.rb', line 158

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}, &block) ⇒ 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) {|instance| instance.state.name == 'running' }

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

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



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/aws-sdk-ec2/instance.rb', line 521

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 = {}) ⇒ Instance

Parameters:

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

    ({})

Options Hash (options):

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

Returns:



377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/aws-sdk-ec2/instance.rb', line 377

def wait_until_exists(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::InstanceExists.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  resp = waiter.wait(params.merge(instance_ids: [@id]))
  Instance.new({
    id: @id,
    data: resp.data.reservations[0].instances[0],
    client: @client
  })
end

#wait_until_running(options = {}) ⇒ Instance

Parameters:

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

    ({})

Options Hash (options):

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

Returns:



395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/aws-sdk-ec2/instance.rb', line 395

def wait_until_running(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::InstanceRunning.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  resp = waiter.wait(params.merge(instance_ids: [@id]))
  Instance.new({
    id: @id,
    data: resp.data.reservations[0].instances[0],
    client: @client
  })
end

#wait_until_stopped(options = {}) ⇒ Instance

Parameters:

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

    ({})

Options Hash (options):

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

Returns:



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

def wait_until_stopped(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::InstanceStopped.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  resp = waiter.wait(params.merge(instance_ids: [@id]))
  Instance.new({
    id: @id,
    data: resp.data.reservations[0].instances[0],
    client: @client
  })
end

#wait_until_terminated(options = {}) ⇒ Instance

Parameters:

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

    ({})

Options Hash (options):

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

Returns:



431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/aws-sdk-ec2/instance.rb', line 431

def wait_until_terminated(options = {})
  options, params = separate_params_and_options(options)
  waiter = Waiters::InstanceTerminated.new(options)
  yield_waiter_and_warn(waiter, &Proc.new) if block_given?
  resp = waiter.wait(params.merge(instance_ids: [@id]))
  Instance.new({
    id: @id,
    data: resp.data.reservations[0].instances[0],
    client: @client
  })
end