Class: AWS::EC2::Instance
- Inherits:
-
Resource
- Object
- Core::Resource
- Resource
- AWS::EC2::Instance
- Includes:
- TaggedItem
- Defined in:
- lib/aws/ec2/instance.rb
Overview
Represents an EC2 instance.
Instance Attribute Summary collapse
-
#ami_launch_index ⇒ Integer
readonly
The AMI launch index, which can be used to find this instance within the launch group.
-
#api_termination_disabled ⇒ Boolean
True if the instance cannot be terminated using the #terminate method.
-
#architecture ⇒ Symbol
readonly
The architecture of the image.
-
#client_token ⇒ String
readonly
Idempotency token you provided when you launched the instance.
-
#dns_name ⇒ String
(also: #public_dns_name)
readonly
The DNS name of the instance on the internet.
-
#hypervisor ⇒ Symbol
readonly
The instance’s hypervisor type.
-
#id ⇒ String
readonly
Returns the instance id.
-
#image_id ⇒ String
readonly
Image ID of the AMI used to launch the instance.
-
#instance_initiated_shutdown_behavior ⇒ String
Valid values are:.
-
#instance_type ⇒ String
The instance type, e.g.
-
#ip_address ⇒ String
(also: #public_ip_address)
readonly
The IP address of the instance.
-
#kernel_id ⇒ String
The ID of the kernel that the image currently uses.
-
#key_name ⇒ String
readonly
The name of the key pair with which this instance was associated at launch.
-
#launch_time ⇒ Time
readonly
The time at which the instance was launched.
-
#monitoring ⇒ Symbol
readonly
The status of CloudWatch monitoring for the instance.
-
#owner_id ⇒ String
readonly
ID of the AWS account that owns the reservation in which the instance was launched.
-
#platform ⇒ String
readonly
A string describing the platform of the image (e.g. “windows”).
-
#private_dns_name ⇒ String
readonly
The DNS name of the instance within the EC2 network.
-
#private_ip_address ⇒ String
readonly
The private IP address assigned to the instance.
-
#ramdisk_id ⇒ String
The ID of the RAM disk that the image currently uses.
-
#requester_id ⇒ String
readonly
ID of the requester that launched the instance on your behalf (e.g., AWS Management Console, Auto Scaling).
-
#reservation_id ⇒ String
readonly
The ID of the reservation in which this instance was launched.
-
#root_device_name ⇒ String
readonly
The name of the root device.
-
#root_device_type ⇒ Symbol
readonly
The root device type used by the AMI.
-
#state_transition_reason ⇒ String
readonly
A string describing the reason for the last state transition.
-
#status ⇒ Symbol
readonly
The instance status.
-
#status_code ⇒ Integer
readonly
The numeric instance status code.
-
#subnet_id ⇒ String?
readonly
Instances launched in a VPC have a subnet_id.
-
#user_data ⇒ String
Arbitrary metadata that is available to the instance while it is running.
-
#virtualization_type ⇒ Symbol
readonly
The instance’s virtualization type.
-
#vpc_id ⇒ String?
readonly
Instances launched in a VPC have a vpc_id.
Instance Method Summary collapse
-
#associate_elastic_ip(elastic_ip) ⇒ nil
(also: #ip_address=)
Associates the elastic IP address with this instance.
-
#availability_zone ⇒ String
The availability zone where the instance is running.
-
#block_device_mappings ⇒ Hash<String,Attachment>
Returns a hash of device mappings.
-
#console_output ⇒ String
Retrieves the console output for the instance.
-
#create_image(name, options = {}) ⇒ Image
Creates an AMI from this instance.
-
#dedicated_tenancy? ⇒ Boolean
Returns true if the instance has dedicated tenancy.
-
#disable_monitoring ⇒ nil
Disables monitoring for this instance.
-
#disassociate_elastic_ip ⇒ Object
Disassociates an attached elastic IP address from this instance.
-
#elastic_ip ⇒ ElasticIp?
Returns an elastic IP address if one is associated with this instance, nil otherwise.
-
#enable_monitoring ⇒ nil
Enables monitoring for this instance.
-
#exists? ⇒ Boolean
Returns true if the instance exists according to EC2.
-
#has_elastic_ip? ⇒ Boolean
Returns true if an elastic IP address is associated with this instance, false otherwise.
-
#image ⇒ Image
The AMI used to launch the instance.
-
#initialize(instance_id, opts = {}) ⇒ Instance
constructor
Creates an object that represents the instance with the given ID.
-
#key_pair ⇒ KeyPair
The key pair with which this instance was associated at launch.
-
#monitoring_enabled=(value) ⇒ Object
Enables or disables monitoring for this instance.
-
#monitoring_enabled? ⇒ Booelan
Returns
true
if CloudWatch monitoring is enabled for this instance. -
#reboot ⇒ nil
Reboots the instance.
-
#reset_kernel_id ⇒ Object
Resets the kernel to its default value.
-
#reset_ramdisk_id ⇒ Object
Resets the RAM disk to its default value.
-
#security_groups ⇒ Array<SecurityGroup>
(also: #groups)
Returns a list of security groups the instance belongs to.
-
#spot_instance? ⇒ Boolean
True if the instance is a Spot instance.
-
#start ⇒ nil
Starts the instance, assuming it is in a stopped state.
-
#stop ⇒ nil
Stops the instance, eventually putting it into a stopped state.
-
#terminate ⇒ nil
(also: #delete)
Terminates the instance.
Methods included from TaggedItem
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.
155 156 157 158 |
# File 'lib/aws/ec2/instance.rb', line 155 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.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def api_termination_disabled @api_termination_disabled end |
#architecture ⇒ Symbol (readonly)
The architecture of the image.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def architecture @architecture end |
#client_token ⇒ String (readonly)
Idempotency token you provided when you launched the instance.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def dns_name @dns_name end |
#hypervisor ⇒ Symbol (readonly)
The instance’s hypervisor type. Valid values:
-
:ovm
-
:xen
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def hypervisor @hypervisor end |
#id ⇒ String (readonly)
Returns the instance id.
161 162 163 |
# File 'lib/aws/ec2/instance.rb', line 161 def id @id end |
#image_id ⇒ String (readonly)
Image ID of the AMI used to launch the instance.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def instance_type @instance_type end |
#ip_address ⇒ String (readonly) Also known as: public_ip_address
The IP address of the instance.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def kernel_id @kernel_id end |
#key_name ⇒ String (readonly)
The name of the key pair with which this instance was associated at launch.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def key_name @key_name end |
#launch_time ⇒ Time (readonly)
The time at which the instance was launched.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def launch_time @launch_time end |
#monitoring ⇒ Symbol (readonly)
The status of CloudWatch monitoring for the instance. Valid values:
-
:enabled
-
:disabled
-
:pending
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def monitoring @monitoring end |
#owner_id ⇒ String (readonly)
ID of the AWS account that owns the reservation in which the instance was launched.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def owner_id @owner_id end |
#platform ⇒ String (readonly)
A string describing the platform of the image (e.g. “windows”).
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def platform @platform end |
#private_dns_name ⇒ String (readonly)
The DNS name of the instance within the EC2 network.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def private_dns_name @private_dns_name end |
#private_ip_address ⇒ String (readonly)
The private IP address assigned to the instance.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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).
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def requester_id @requester_id end |
#reservation_id ⇒ String (readonly)
The ID of the reservation in which this instance was launched.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def reservation_id @reservation_id end |
#root_device_name ⇒ String (readonly)
The name of the root device.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def root_device_type @root_device_type end |
#state_transition_reason ⇒ String (readonly)
A string describing the reason for the last state transition.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def state_transition_reason @state_transition_reason end |
#status ⇒ Symbol (readonly)
The instance status. Valid values are:
-
:pending
-
:running
-
:shutting_down
-
:terminated
-
:stopping
-
:stopped
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def status @status end |
#status_code ⇒ Integer (readonly)
The numeric instance status code.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def status_code @status_code end |
#subnet_id ⇒ String? (readonly)
Instances launched in a VPC have a subnet_id. Normal EC2 instances return nil.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 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"
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def user_data @user_data end |
#virtualization_type ⇒ Symbol (readonly)
The instance’s virtualization type. Valid values:
-
:paravirtual
-
:hvm
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def virtualization_type @virtualization_type end |
#vpc_id ⇒ String? (readonly)
Instances launched in a VPC have a vpc_id. Normal EC2 instances return nil.
147 148 149 |
# File 'lib/aws/ec2/instance.rb', line 147 def vpc_id @vpc_id end |
Instance Method Details
#associate_elastic_ip(elastic_ip) ⇒ nil Also known as: ip_address=
Associates the elastic IP address with this instance.
479 480 481 482 483 484 485 |
# File 'lib/aws/ec2/instance.rb', line 479 def associate_elastic_ip elastic_ip client.associate_address( :public_ip => elastic_ip.to_s, :instance_id => self.id ) nil end |
#availability_zone ⇒ String
Returns The availability zone where the instance is running.
410 411 412 413 414 |
# File 'lib/aws/ec2/instance.rb', line 410 def availability_zone if p = placement p.availability_zone end end |
#block_device_mappings ⇒ Hash<String,Attachment>
Returns a hash of device mappings. The keys are device name strings (e.g. ‘/dev/sda’) and the values are Attachment objects.
366 367 368 369 370 371 372 373 374 |
# File 'lib/aws/ec2/instance.rb', line 366 def block_device_mappings (block_device_mapping || []).inject({}) do |m, mapping| device = mapping.device_name volume = Volume.new(mapping.ebs.volume_id, :config => config) = Attachment.new(volume, self, device, :config => config) m[device] = m end end |
#console_output ⇒ String
Retrieves the console output for the instance.
469 470 471 |
# File 'lib/aws/ec2/instance.rb', line 469 def console_output Base64.decode64(client.get_console_output(:instance_id => self.id).output) end |
#create_image(name, options = {}) ⇒ Image
Creates an AMI from this instance.
461 462 463 464 |
# File 'lib/aws/ec2/instance.rb', line 461 def create_image name, = {} images = ImageCollection.new(:config => config) images.create(.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.
419 420 421 422 423 424 425 |
# File 'lib/aws/ec2/instance.rb', line 419 def dedicated_tenancy? if p = placement p.tenancy == 'dedicated' else false end end |
#disable_monitoring ⇒ nil
Disables monitoring for this instance.
385 386 387 388 |
# File 'lib/aws/ec2/instance.rb', line 385 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.
492 493 494 495 496 497 498 |
# File 'lib/aws/ec2/instance.rb', line 492 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.
502 503 504 505 |
# File 'lib/aws/ec2/instance.rb', line 502 def elastic_ip ips = ElasticIpCollection.new(:config => config) ips.filter('instance-id', id).first end |
#enable_monitoring ⇒ nil
Enables monitoring for this instance.
378 379 380 381 |
# File 'lib/aws/ec2/instance.rb', line 378 def enable_monitoring client.monitor_instances(:instance_ids => [id]) nil end |
#exists? ⇒ Boolean
Returns true if the instance exists according to EC2.
515 516 517 518 519 |
# File 'lib/aws/ec2/instance.rb', line 515 def exists? client.describe_instances(:filters => [ { :name => "instance-id", :values => [id] } ]).instance_index.key?(id) end |
#has_elastic_ip? ⇒ Boolean
Returns true if an elastic IP address is associated with this instance, false otherwise.
509 510 511 |
# File 'lib/aws/ec2/instance.rb', line 509 def has_elastic_ip? !elastic_ip.nil? end |
#image ⇒ Image
Returns The AMI used to launch the instance.
428 429 430 |
# File 'lib/aws/ec2/instance.rb', line 428 def image Image.new(image_id, :config => config) end |
#key_pair ⇒ KeyPair
Returns The key pair with which this instance was associated at launch.
434 435 436 |
# File 'lib/aws/ec2/instance.rb', line 434 def key_pair KeyPair.new(key_name, :config => config) if key_name end |
#monitoring_enabled=(value) ⇒ Object
Enables or disables monitoring for this instance.
393 394 395 |
# File 'lib/aws/ec2/instance.rb', line 393 def monitoring_enabled= value value ? enable_monitoring : disable_monitoring end |
#monitoring_enabled? ⇒ Booelan
Returns true
if CloudWatch monitoring is enabled for this instance.
399 400 401 |
# File 'lib/aws/ec2/instance.rb', line 399 def monitoring_enabled? monitoring == :enabled end |
#reboot ⇒ nil
Reboots the instance.
542 543 544 |
# File 'lib/aws/ec2/instance.rb', line 542 def reboot instance_action :reboot end |
#reset_kernel_id ⇒ Object
Resets the kernel to its default value.
522 523 524 525 |
# File 'lib/aws/ec2/instance.rb', line 522 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.
528 529 530 531 |
# File 'lib/aws/ec2/instance.rb', line 528 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.
355 356 357 358 359 |
# File 'lib/aws/ec2/instance.rb', line 355 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.
404 405 406 |
# File 'lib/aws/ec2/instance.rb', line 404 def spot_instance? instance_lifecycle == :spot end |
#start ⇒ nil
Starts the instance, assuming it is in a stopped state.
549 550 551 |
# File 'lib/aws/ec2/instance.rb', line 549 def start instance_action :start end |
#stop ⇒ nil
Stops the instance, eventually putting it into a stopped state.
555 556 557 |
# File 'lib/aws/ec2/instance.rb', line 555 def stop instance_action :stop end |
#terminate ⇒ nil Also known as: delete
Terminates the instance.
535 536 537 |
# File 'lib/aws/ec2/instance.rb', line 535 def terminate instance_action :terminate end |