Class: AWS::EC2::Instance

Inherits:
Resource
  • Object
show all
Includes:
TaggedItem
Defined in:
lib/aws/ec2/instance.rb

Overview

Represents an EC2 instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TaggedItem

#add_tag, #clear_tags, #tags

Constructor Details

#initialize(instance_id, opts = {}) ⇒ Instance

Creates an object that represents the instance with the given ID. It's usually easier to get an instance of this class by calling AWS::EC2::InstanceCollection#[] or AWS::EC2::InstanceCollection#each.



166
167
168
169
 
# File 'lib/aws/ec2/instance.rb', line 166

def initialize(instance_id, opts = {})
  super
  @id = instance_id
end

Instance Attribute Details

#ami_launch_index ⇒ Integer (readonly)

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

Returns:

  • (Integer) —

    the current value of ami_launch_index



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

def ami_launch_index
  @ami_launch_index
end

#api_termination_disabled ⇒ Boolean

True if the instance cannot be terminated using the #terminate method. This attribute can be changed at any time.

Returns:

  • (Boolean) —

    the current value of api_termination_disabled



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

def api_termination_disabled
  @api_termination_disabled
end

#architecture ⇒ Symbol (readonly)

The architecture of the image.

Returns:

  • (Symbol) —

    the current value of architecture



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

def architecture
  @architecture
end

#client_token ⇒ String (readonly)

Idempotency token you provided when you launched the instance.

Returns:

  • (String) —

    the current value of client_token



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

def client_token
  @client_token
end

#dns_name ⇒ String (readonly) Also known as: public_dns_name

The DNS name of the instance on the internet.

Returns:

  • (String) —

    the current value of dns_name



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

def dns_name
  @dns_name
end

#ebs_optimized ⇒ Boolean

The instance must be in a stopped state to change the ebs_optimized state.

Returns:

  • (Boolean) —

    the current value of ebs_optimized



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

def ebs_optimized
  @ebs_optimized
end

#hypervisor ⇒ Symbol (readonly)

The instance's hypervisor type. Valid values:

  • :ovm
  • :xen

Returns:

  • (Symbol) —

    the current value of hypervisor



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

def hypervisor
  @hypervisor
end

#iam_instance_profile_arn ⇒ String? (readonly)

Returns the current value of iam_instance_profile_arn.

Returns:

  • (String, nil) —

    the current value of iam_instance_profile_arn



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

def iam_instance_profile_arn
  @iam_instance_profile_arn
end

#iam_instance_profile_id ⇒ String? (readonly)

Returns the current value of iam_instance_profile_id.

Returns:

  • (String, nil) —

    the current value of iam_instance_profile_id



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

def iam_instance_profile_id
  @iam_instance_profile_id
end

#id ⇒ String (readonly) Also known as: instance_id

Returns the instance id.

Returns:

  • (String) —

    Returns the instance id.



172
173
174
 
# File 'lib/aws/ec2/instance.rb', line 172

def id
  @id
end

#image_id ⇒ String (readonly)

Image ID of the AMI used to launch the instance.

Returns:

  • (String) —

    the current value of image_id



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

def image_id
  @image_id
end

#instance_initiated_shutdown_behavior ⇒ String

Valid values are:

  • "stop"] When the instance shuts down, it will go into a "stopped" state.
  • "terminate"] When the instance shuts down, it will be terminated.

Returns:

  • (String) —

    the current value of instance_initiated_shutdown_behavior



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

def instance_initiated_shutdown_behavior
  @instance_initiated_shutdown_behavior
end

#instance_type ⇒ String

The instance type, e.g. "m1.small". The instance must be in a stopped state to change the instance type.

Returns:

  • (String) —

    the current value of instance_type



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

def instance_type
  @instance_type
end

#ip_address ⇒ String (readonly) Also known as: public_ip_address

The IP address of the instance.

Returns:

  • (String) —

    the current value of ip_address



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

def ip_address
  @ip_address
end

#kernel_id ⇒ String

The ID of the kernel that the image currently uses. The instance must be in a stopped state to change this attribute.

Returns:

  • (String) —

    the current value of kernel_id



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

def kernel_id
  @kernel_id
end

#key_name ⇒ String (readonly)

The name of the key pair with which this instance was associated at launch.

Returns:

  • (String) —

    the current value of key_name



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

def key_name
  @key_name
end

#launch_time ⇒ Time (readonly)

The time at which the instance was launched.

Returns:

  • (Time) —

    the current value of launch_time



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

def launch_time
  @launch_time
end

#monitoring ⇒ Symbol (readonly)

The status of CloudWatch monitoring for the instance. Valid values:

  • :enabled
  • :disabled
  • :pending

Returns:

  • (Symbol) —

    the current value of monitoring



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

def monitoring
  @monitoring
end

#owner_id ⇒ String (readonly)

ID of the AWS account that owns the reservation in which the instance was launched.

Returns:

  • (String) —

    the current value of owner_id



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

def owner_id
  @owner_id
end

#platform ⇒ String (readonly)

A string describing the platform of the image (e.g. "windows").

Returns:

  • (String) —

    the current value of platform



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

def platform
  @platform
end

#private_dns_name ⇒ String (readonly)

The DNS name of the instance within the EC2 network.

Returns:

  • (String) —

    the current value of private_dns_name



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

def private_dns_name
  @private_dns_name
end

#private_ip_address ⇒ String (readonly)

The private IP address assigned to the instance.

Returns:

  • (String) —

    the current value of private_ip_address



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

def private_ip_address
  @private_ip_address
end

#ramdisk_id ⇒ String

The ID of the RAM disk that the image currently uses. The instance must be in a stopped state to change this attribute.

Returns:

  • (String) —

    the current value of ramdisk_id



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

def ramdisk_id
  @ramdisk_id
end

#requester_id ⇒ String (readonly)

ID of the requester that launched the instance on your behalf (e.g., AWS Management Console, Auto Scaling).

Returns:

  • (String) —

    the current value of requester_id



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

def requester_id
  @requester_id
end

#reservation_id ⇒ String (readonly)

The ID of the reservation in which this instance was launched.

Returns:

  • (String) —

    the current value of reservation_id



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

def reservation_id
  @reservation_id
end

#root_device_name ⇒ String (readonly)

The name of the root device.

Returns:

  • (String) —

    the current value of root_device_name



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

def root_device_name
  @root_device_name
end

#root_device_type ⇒ Symbol (readonly)

The root device type used by the AMI. The AMI can use an Amazon EBS or instance store root device. Valid values:

  • :ebs
  • :instance_store

Returns:

  • (Symbol) —

    the current value of root_device_type



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

def root_device_type
  @root_device_type
end

#state_transition_reason ⇒ String (readonly)

A string describing the reason for the last state transition.

Returns:

  • (String) —

    the current value of state_transition_reason



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

def state_transition_reason
  @state_transition_reason
end

#status ⇒ Symbol (readonly)

The instance status. Valid values are:

  • :pending
  • :running
  • :shutting_down
  • :terminated
  • :stopping
  • :stopped

Returns:

  • (Symbol) —

    the current value of status



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

def status
  @status
end

#status_code ⇒ Integer (readonly)

The numeric instance status code.

Returns:

  • (Integer) —

    the current value of status_code



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

def status_code
  @status_code
end

#subnet_id ⇒ String? (readonly)

Instances launched in a VPC have a subnet_id. Normal EC2 instances return nil.

Returns:

  • (String, nil) —

    the current value of subnet_id



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

def subnet_id
  @subnet_id
end

#user_data ⇒ String

Arbitrary metadata that is available to the instance while it is running. This interface handles the details of encoding the user data for transmission; you should set the user data exactly as you want it to be made available to the instance.

The instance must be in a stopped state to change user data; for example:

i.user_data             # => "HELLO"
i.status                # => :running
i.user_data = "GOODBYE" # raises an exception
i.stop; sleep 1 until i.status == :stopped
i.user_data = "GOODBYE" # => "GOODBYE"

Returns:

  • (String) —

    the current value of user_data



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

def user_data
  @user_data
end

#virtualization_type ⇒ Symbol (readonly)

The instance's virtualization type. Valid values:

  • :paravirtual
  • :hvm

Returns:

  • (Symbol) —

    the current value of virtualization_type



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

def virtualization_type
  @virtualization_type
end

#vpc_id ⇒ String? (readonly)

Instances launched in a VPC have a vpc_id. Normal EC2 instances return nil.

Returns:

  • (String, nil) —

    the current value of vpc_id



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

def vpc_id
  @vpc_id
end

Instance Method Details

#associate_elastic_ip(elastic_ip) ⇒ nil #associate_elastic_ip(allocation_id) ⇒ nil Also known as: ip_address=

Associates the elastic IP address with this instance.

Overloads:

  • #associate_elastic_ip(elastic_ip) ⇒ nil

    Parameters:

    • elastic_ip (ElasticIp, String) —

      An Elastic ip address (VPC or non-VPC) or a public ip address string (non-VPC only).

  • #associate_elastic_ip(allocation_id) ⇒ nil

    Parameters:

    • allocation_id (String) —

      The allocation id of a VPC elastic ip address.

Returns:

  • (nil) 


596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/aws/ec2/instance.rb', line 596

def associate_elastic_ip elastic_ip

  client_opts = {}
  client_opts[:instance_id] = self.id

  if vpc?
    client_opts[:allocation_id] = elastic_ip.is_a?(ElasticIp) ?
      elastic_ip.allocation_id :
      elastic_ip.to_s
  else
    client_opts[:public_ip] = elastic_ip.to_s
  end

  client.associate_address(client_opts)
  nil

end

#attach_network_interface(network_interface, options = {}) ⇒ nil

Attaches a network interface to this instance (VPC only).

Parameters:

  • network_interface (NetworkInterface, String) —

    A network interface (or network interface id string) to attach to this vpc instance.

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

Options Hash (options):

  • :device_index (Integer) — default: 1 —

    The index of the device for the network interface attachment on the instance. Defaults to 1.

Returns:

  • (nil) 


426
427
428
429
430
431
432
433
434
 
# File 'lib/aws/ec2/instance.rb', line 426

def attach_network_interface network_interface, options = {}
  if network_interface.is_a?(NetworkInterface)
    network_interface.attach(self, options)
  else
    i = NetworkInterface.new(network_interface, :config => config)
    i.attach(self, options)
  end
  nil
end

#attachments ⇒ Hash<String,Attachment> Also known as: block_device_mappings

Note:

This method will not return data for ephemeral volumes.

Returns a hash of attachments. The keys are device name strings (e.g. '/dev/sda') and the values are Attachment objects.

Returns:

  • (Hash<String,Attachment>) —

    Returns a hash of attachments. The keys are device name strings (e.g. '/dev/sda') and the values are Attachment objects.

See Also:

  • AWS::EC2::Instance.{{#block_devices}


450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/aws/ec2/instance.rb', line 450

def attachments
  (block_device_mapping || []).inject({}) do |m, mapping|
    if mapping[:ebs]
      device = mapping[:device_name]
      volume = Volume.new(mapping[:ebs][:volume_id], :config => config)
      attachment = Attachment.new(volume, self, device, :config => config)
      m[device] = attachment
    end
    m
  end
end

#availability_zone ⇒ String

Returns The availability zone where the instance is running.

Returns:

  • (String) —

    The availability zone where the instance is running.



522
523
524
525
526
 
# File 'lib/aws/ec2/instance.rb', line 522

def availability_zone
  if p = placement
    p.availability_zone
  end
end

#block_devices ⇒ Array<Hash>

Returns a list of block device mappings.

instance.block_devices
#=>
[
  {
    :device_name => "/dev/sda2",
    :ebs => {
      :volume_id => "vol-123",
      :status => "attaching",
      :attach_time => time,
      :delete_on_termination => true
    }
  }, {
    :device_name => "/dev/sdb",
    :virtual_name => "ephemeral0",
  }
]

Returns:

  • (Array<Hash>) —

    Returns a list of block device mappings. This list may contain ephemeral volumes.



484
485
486
 
# File 'lib/aws/ec2/instance.rb', line 484

def block_devices
  block_device_mapping.to_a
end

#console_output ⇒ String

Retrieves the console output for the instance.

Returns:

  • (String) —

    the console output.



579
580
581
582
 
# File 'lib/aws/ec2/instance.rb', line 579

def console_output
  output = client.get_console_output(:instance_id => self.id).output
  Base64.decode64(output) if output
end

#create_image(name, options = {}) ⇒ Image

Creates an AMI from this instance.

Parameters:

  • name (String) —

    A name for the new image you're creating. Constraints: 3-128 alphanumeric characters, parenthesis (()), commas (,), slashes (/), dashes (-), or underscores(_)

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

    Additional options for creating the image.

Options Hash (options):

  • :description (String) —

    A description of the new image.

  • :no_reboot (Boolean) —

    By default this option is set to false, which means Amazon EC2 attempts to cleanly shut down the instance before image creation and reboots the instance afterwards. When the option is set to true, Amazon EC2 does not shut down the instance before creating the image. When this option is used, file system integrity on the created image cannot be guaranteed.

Returns:

  • (Image) —

    The newly created image.



571
572
573
574
 
# File 'lib/aws/ec2/instance.rb', line 571

def create_image name, options = {}
  images = ImageCollection.new(:config => config)
  images.create(options.merge(:instance_id => id, :name => name))
end

#dedicated_tenancy? ⇒ Boolean

Returns true if the instance has dedicated tenancy. This will be false for all non-VPC instances. Dedicated Tenancy comes at extra cost.

Returns:

  • (Boolean) —

    Returns true if the instance has dedicated tenancy. This will be false for all non-VPC instances. Dedicated Tenancy comes at extra cost.



531
532
533
534
535
536
537
 
# File 'lib/aws/ec2/instance.rb', line 531

def dedicated_tenancy?
  if p = placement
    p.tenancy == 'dedicated'
  else
    false
  end
end

#disable_monitoring ⇒ nil

Disables monitoring for this instance.

Returns:

  • (nil) 


497
498
499
500
 
# File 'lib/aws/ec2/instance.rb', line 497

def disable_monitoring
  client.unmonitor_instances(:instance_ids => [id])
  nil
end

#disassociate_elastic_ip ⇒ Object

Disassociates an attached elastic IP address from this instance. Raises an exception if there is no elastic IP address associated with this instance.



619
620
621
622
623
624
625
 
# File 'lib/aws/ec2/instance.rb', line 619

def disassociate_elastic_ip
  if ip = self.elastic_ip
    ip.disassociate
  else
    raise "instance #{id} does not have an associated elastic ip"
  end
end

#elastic_ip ⇒ ElasticIp?

Returns an elastic IP address if one is associated with this instance, nil otherwise.

Returns:

  • (ElasticIp, nil) —

    Returns an elastic IP address if one is associated with this instance, nil otherwise.



629
630
631
632
 
# File 'lib/aws/ec2/instance.rb', line 629

def elastic_ip
  ips = ElasticIpCollection.new(:config => config)
  ips.filter('instance-id', id).first
end

#enable_monitoring ⇒ nil

Enables monitoring for this instance.

Returns:

  • (nil) 


490
491
492
493
 
# File 'lib/aws/ec2/instance.rb', line 490

def enable_monitoring
  client.monitor_instances(:instance_ids => [id])
  nil
end

#exists? ⇒ Boolean

Returns true if the instance exists according to EC2.

Returns:

  • (Boolean) —

    Returns true if the instance exists according to EC2.



642
643
644
645
646
 
# File 'lib/aws/ec2/instance.rb', line 642

def exists?
  client.describe_instances(:filters => [
    { :name => "instance-id", :values => [id] }
  ]).instance_index.key?(id)
end

#export_to_s3(bucket, options = {}) ⇒ ExportTask

This produces an image of an EC2 instance for use in another virtualization environment and then writes the image to a S3 bucket.

Granting EC2 write access to your bucket

Before you can export an image to an S3 bucket, you must modify the bucket ACL. You only need to do this once per bucket.

s3.buckets['bucket-name'].acl.change do |acl|
  acl.grant(:read_acp).to(:amazon_customer_email => '[email protected]')
  acl.grant(:write).to(:amazon_customer_email => '[email protected]')
end

Performing the export

Simply call #export_to_s3 on your instance. Only instances derived from your own ImportInstance tasks may be exported.

 task = ec2.instances['i-12345678'].export_to_s3('bucket-name')

Downloading the results

Given a completed export task you can download the final image:

File.open('image.ova', 'w') {|f| f.write(task.s3_object.read) }

Parameters:

  • bucket (S3::Bucket, String) —

    The destination bucket. May be the name of the bucket (string) or a S3::Bucket object. The bucket must exist and grant write permissiosn to the AWS account '[email protected].'.

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

Options Hash (options):

  • :target_environment (String) — default: 'vmware' —

    The target virtualization environment. Valid values include: 'vmware', 'citrix' and 'microsoft'.

  • :disk_image_format (String) —

    The format for the exported image. Defaults to 'vmdk' if :target_environemnt is 'vmware', otherwise, 'vhd'.

  • :container_format (String) —

    The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image will be exported. Defaults to 'ova' if :target_environment is 'vmware', otherwise ommited.

  • :description (String) —

    Description of the conversion task or the resource being exported.

  • :prefix (String) — default: nil —

    The image is written to a single object in the bucket at the key:

    "#{prefix}#{export_task_id}.#{disk_image_format}"

Returns:



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/aws/ec2/instance.rb', line 743

def export_to_s3 bucket, options = {}

  bucket_name = bucket.is_a?(S3::Bucket) ? bucket.name : bucket.to_s

  opts = {}
  opts[:instance_id] = instance_id
  opts[:description] = options[:description] if options[:description]
  opts[:target_environment] = options[:target_environment] || 'vmware'
  opts[:export_to_s3] = {}
  opts[:export_to_s3][:s3_bucket] = bucket_name
  [:disk_image_format, :container_format, :s3_prefix].each do |opt|
    opts[:export_to_s3][opt] = options[opt] if options.key?(opt)
  end

  resp = client.create_instance_export_task(opts)

  ExportTask.new_from(
    :create_instance_export_task,
    resp[:export_task],
    resp[:export_task][:export_task_id],
    :config => config)

end

#has_elastic_ip? ⇒ Boolean

Returns true if an elastic IP address is associated with this instance, false otherwise.

Returns:

  • (Boolean) —

    Returns true if an elastic IP address is associated with this instance, false otherwise.



636
637
638
 
# File 'lib/aws/ec2/instance.rb', line 636

def has_elastic_ip?
  !elastic_ip.nil?
end

#image ⇒ Image

Returns The AMI used to launch the instance.

Returns:

  • (Image) —

    The AMI used to launch the instance.



540
541
542
 
# File 'lib/aws/ec2/instance.rb', line 540

def image
  Image.new(image_id, :config => config)
end

#key_pair ⇒ KeyPair

Returns The key pair with which this instance was associated at launch.

Returns:

  • (KeyPair) —

    The key pair with which this instance was associated at launch.



546
547
548
 
# File 'lib/aws/ec2/instance.rb', line 546

def key_pair
  KeyPair.new(key_name, :config => config) if key_name
end

#monitoring_enabled=(state) ⇒ Object

Enables or disables monitoring for this instance.

Parameters:

  • state (Boolean) —

    A true or false value. Enables monintoring for a true value, disables it for a false value.



505
506
507
 
# File 'lib/aws/ec2/instance.rb', line 505

def monitoring_enabled= state
  state ? enable_monitoring : disable_monitoring
end

#monitoring_enabled? ⇒ Booelan

Returns true if CloudWatch monitoring is enabled for this instance.

Returns:

  • (Booelan) —

    Returns true if CloudWatch monitoring is enabled for this instance.



511
512
513
 
# File 'lib/aws/ec2/instance.rb', line 511

def monitoring_enabled?
  monitoring == :enabled
end

#network_interfaces ⇒ Array<NetworkInterface>

Returns a list of elastic network interfaces attached to this instance (VPC only). Non-vpc instance may not have attached network interfaces.

Returns:

  • (Array<NetworkInterface>) —

    Returns a list of elastic network interfaces attached to this instance (VPC only). Non-vpc instance may not have attached network interfaces.



408
409
410
411
412
413
 
# File 'lib/aws/ec2/instance.rb', line 408

def network_interfaces
  network_interface_set.collect do |ni|
    NetworkInterface.new_from(:describe_network_interfaces, ni,
      ni.network_interface_id, :config => config)
  end
end

#reboot ⇒ nil

Reboots the instance.

Returns:

  • (nil) 


669
670
671
 
# File 'lib/aws/ec2/instance.rb', line 669

def reboot
  instance_action :reboot
end

#reset_kernel_id ⇒ Object

Resets the kernel to its default value.



649
650
651
652
 
# File 'lib/aws/ec2/instance.rb', line 649

def reset_kernel_id
  client.reset_instance_attribute(
    :instance_id => id, :attribute => "kernel").return
end

#reset_ramdisk_id ⇒ Object

Resets the RAM disk to its default value.



655
656
657
658
 
# File 'lib/aws/ec2/instance.rb', line 655

def reset_ramdisk_id
  client.reset_instance_attribute(
    :instance_id => id, :attribute => "ramdisk").return
end

#security_groups ⇒ Array<SecurityGroup> Also known as: groups

Returns a list of security groups the instance belongs to.

Returns:

  • (Array<SecurityGroup>) —

    Returns a list of security groups the instance belongs to.



438
439
440
441
442
 
# File 'lib/aws/ec2/instance.rb', line 438

def security_groups
  (group_set || []).collect do |g|
    SecurityGroup.new(g.group_id, :name => g.group_name, :config => config)
  end
end

#spot_instance? ⇒ Boolean

Returns true if the instance is a Spot instance.

Returns:

  • (Boolean) —

    true if the instance is a Spot instance.



516
517
518
 
# File 'lib/aws/ec2/instance.rb', line 516

def spot_instance?
  instance_lifecycle == :spot
end

#start ⇒ nil

Starts the instance, assuming it is in a stopped state.

Returns:

  • (nil)

See Also:



676
677
678
 
# File 'lib/aws/ec2/instance.rb', line 676

def start
  instance_action :start
end

#stop ⇒ nil

Stops the instance, eventually putting it into a stopped state.

Returns:

  • (nil) 


682
683
684
 
# File 'lib/aws/ec2/instance.rb', line 682

def stop
  instance_action :stop
end

#subnet ⇒ Subnet?

Returns the VPC subnet this instance was launched in. Returns nil if this was not launched in a VPC.

Returns:

  • (Subnet, nil) —

    Returns the VPC subnet this instance was launched in. Returns nil if this was not launched in a VPC.



399
400
401
402
403
 
# File 'lib/aws/ec2/instance.rb', line 399

def subnet
  if subnet_id
    Subnet.new(subnet_id, :vpc_id => vpc_id, :config => config)
  end
end

#terminate ⇒ nil Also known as: delete

Terminates the instance.

Returns:

  • (nil) 


662
663
664
 
# File 'lib/aws/ec2/instance.rb', line 662

def terminate
  instance_action :terminate
end

#vpc ⇒ VPC?

Returns the VPC this instance was launched in. If this instance was not launched inside a VPC, nil is returned.

Returns:

  • (VPC, nil) —

    Returns the VPC this instance was launched in. If this instance was not launched inside a VPC, nil is returned.



391
392
393
394
395
 
# File 'lib/aws/ec2/instance.rb', line 391

def vpc
  if vpc_id
    VPC.new(vpc_id, :config => config)
  end
end

#vpc? ⇒ Boolean

Returns true if this is an EC2 VPC instance.

Returns:

  • (Boolean) —

    Returns true if this is an EC2 VPC instance.



385
386
387
 
# File 'lib/aws/ec2/instance.rb', line 385

def vpc?
  !!vpc_id
end