Class: Aws::EC2::Instance
- Inherits:
-
Object
- Object
- Aws::EC2::Instance
- Defined in:
- gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb,
gems/aws-sdk-ec2/lib/aws-sdk-ec2/customizations/instance.rb
Defined Under Namespace
Classes: Collection
Read-Only Attributes collapse
-
#ami_launch_index ⇒ Integer
The AMI launch index, which can be used to find this instance in the launch group.
-
#architecture ⇒ String
The architecture of the image.
-
#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>
Any block device mapping entries for the instance.
-
#boot_mode ⇒ String
The boot mode of the instance.
-
#capacity_reservation_id ⇒ String
The ID of the Capacity Reservation.
-
#capacity_reservation_specification ⇒ Types::CapacityReservationSpecificationResponse
Information about the Capacity Reservation targeting option.
-
#client_token ⇒ String
The idempotency token you provided when you launched the instance, if applicable.
-
#cpu_options ⇒ Types::CpuOptions
The CPU options for the instance.
-
#ebs_optimized ⇒ Boolean
Indicates whether the instance is optimized for Amazon EBS I/O.
-
#elastic_gpu_associations ⇒ Array<Types::ElasticGpuAssociation>
The Elastic GPU associated with the instance.
-
#elastic_inference_accelerator_associations ⇒ Array<Types::ElasticInferenceAcceleratorAssociation>
The elastic inference accelerator associated with the instance.
-
#ena_support ⇒ Boolean
Specifies whether enhanced networking with ENA is enabled.
-
#enclave_options ⇒ Types::EnclaveOptions
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
-
#hibernation_options ⇒ Types::HibernationOptions
Indicates whether the instance is enabled for hibernation.
-
#hypervisor ⇒ String
The hypervisor type of the instance.
-
#iam_instance_profile ⇒ Types::IamInstanceProfile
The IAM instance profile associated with the instance, if applicable.
-
#id ⇒ String
(also: #instance_id)
-
#image_id ⇒ String
The ID of the AMI used to launch the instance.
-
#instance_lifecycle ⇒ String
Indicates whether this is a Spot Instance or a Scheduled Instance.
-
#instance_type ⇒ String
The instance type.
-
#ipv_6_address ⇒ String
The IPv6 address assigned to the instance.
-
#kernel_id ⇒ String
The kernel associated with this instance, if applicable.
-
#key_name ⇒ String
The name of the key pair, if this instance was launched with an associated key pair.
-
#launch_time ⇒ Time
The time the instance was launched.
-
#licenses ⇒ Array<Types::LicenseConfiguration>
The license configurations for the instance.
-
#maintenance_options ⇒ Types::InstanceMaintenanceOptions
Provides information on the recovery and maintenance options of your instance.
-
#metadata_options ⇒ Types::InstanceMetadataOptionsResponse
The metadata options for the instance.
-
#monitoring ⇒ Types::Monitoring
The monitoring for the instance.
-
#outpost_arn ⇒ String
The Amazon Resource Name (ARN) of the Outpost.
-
#placement ⇒ Types::Placement
The location where the instance launched, if applicable.
-
#platform ⇒ String
The value is
Windows
for Windows instances; otherwise blank. -
#platform_details ⇒ String
The platform details value for the instance.
-
#private_dns_name ⇒ String
(IPv4 only) The private DNS hostname name assigned to the instance.
-
#private_dns_name_options ⇒ Types::PrivateDnsNameOptionsResponse
The options for the instance hostname.
-
#private_ip_address ⇒ String
The private IPv4 address assigned to the instance.
-
#product_codes ⇒ Array<Types::ProductCode>
The product codes attached to this instance, if applicable.
-
#public_dns_name ⇒ String
(IPv4 only) The public DNS name assigned to the instance.
-
#public_ip_address ⇒ String
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
-
#ramdisk_id ⇒ String
The RAM disk associated with this instance, if applicable.
-
#root_device_name ⇒ String
The device name of the root device volume (for example,
/dev/sda1
). -
#root_device_type ⇒ String
The root device type used by the AMI.
-
#security_groups ⇒ Array<Types::GroupIdentifier>
The security groups for the instance.
-
#source_dest_check ⇒ Boolean
Indicates whether source/destination checking is enabled.
-
#spot_instance_request_id ⇒ String
If the request is a Spot Instance request, the ID of the request.
-
#sriov_net_support ⇒ String
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
-
#state ⇒ Types::InstanceState
The current state of the instance.
-
#state_reason ⇒ Types::StateReason
The reason for the most recent state transition.
-
#state_transition_reason ⇒ String
The reason for the most recent state transition.
-
#subnet_id ⇒ String
[EC2-VPC] The ID of the subnet in which the instance is running.
-
#tags ⇒ Array<Types::Tag>
Any tags assigned to the instance.
-
#tpm_support ⇒ String
If the instance is configured for NitroTPM support, the value is
v2.0
. -
#usage_operation ⇒ String
The usage operation value for the instance.
-
#usage_operation_update_time ⇒ Time
The time that the usage operation was last updated.
-
#virtualization_type ⇒ String
The virtualization type of the instance.
-
#vpc_id ⇒ String
[EC2-VPC] The ID of the VPC in which the instance is running.
Actions collapse
-
#attach_classic_link_vpc(options = {}) ⇒ Types::AttachClassicLinkVpcResult
-
#attach_volume(options = {}) ⇒ Types::VolumeAttachment
-
#console_output(options = {}) ⇒ Types::GetConsoleOutputResult
-
#create_image(options = {}) ⇒ Image
-
#create_tags(options = {}) ⇒ Tag::Collection
-
#delete_tags(options = {}) ⇒ Tag::Collection
-
#describe_attribute(options = {}) ⇒ Types::InstanceAttribute
-
#detach_classic_link_vpc(options = {}) ⇒ Types::DetachClassicLinkVpcResult
-
#detach_volume(options = {}) ⇒ Types::VolumeAttachment
-
#modify_attribute(options = {}) ⇒ EmptyStructure
-
#monitor(options = {}) ⇒ Types::MonitorInstancesResult
-
#password_data(options = {}) ⇒ Types::GetPasswordDataResult
-
#reboot(options = {}) ⇒ EmptyStructure
-
#report_status(options = {}) ⇒ EmptyStructure
-
#reset_attribute(options = {}) ⇒ EmptyStructure
-
#reset_kernel(options = {}) ⇒ EmptyStructure
-
#reset_ramdisk(options = {}) ⇒ EmptyStructure
-
#reset_source_dest_check(options = {}) ⇒ EmptyStructure
-
#start(options = {}) ⇒ Types::StartInstancesResult
-
#stop(options = {}) ⇒ Types::StopInstancesResult
-
#terminate(options = {}) ⇒ Types::TerminateInstancesResult
-
#unmonitor(options = {}) ⇒ Types::UnmonitorInstancesResult
Associations collapse
-
#classic_address ⇒ ClassicAddress?
-
#image ⇒ Image?
-
#key_pair ⇒ KeyPairInfo?
-
#network_interfaces ⇒ NetworkInterface::Collection
-
#placement_group ⇒ PlacementGroup?
-
#subnet ⇒ Subnet?
-
#volumes(options = {}) ⇒ Volume::Collection
-
#vpc ⇒ Vpc?
-
#vpc_addresses(options = {}) ⇒ VpcAddress::Collection
Instance Method Summary collapse
-
#client ⇒ Client
-
#data ⇒ Types::Instance
Returns the data for this Instance.
-
#data_loaded? ⇒ Boolean
Returns
true
if this resource is loaded. -
#decrypt_windows_password(key_pair_path) ⇒ String
-
#exists?(options = {}) ⇒ Boolean
Returns
true
if the Instance exists. -
#initialize(*args) ⇒ Instance
constructor
A new instance of Instance.
- #load ⇒ self (also: #reload)
-
#wait_until(options = {}) {|resource| ... } ⇒ Resource
deprecated
Deprecated.
Use [Aws::EC2::Client] #wait_until instead
-
#wait_until_exists(options = {}, &block) ⇒ Instance
-
#wait_until_running(options = {}, &block) ⇒ Instance
-
#wait_until_stopped(options = {}, &block) ⇒ Instance
-
#wait_until_terminated(options = {}, &block) ⇒ Instance
Constructor Details
#initialize(id, options = {}) ⇒ Instance #initialize(options = {}) ⇒ Instance
Returns a new instance of Instance.
22 23 24 25 26 27 28 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 22 def initialize(*args) = Hash === args.last ? args.pop.dup : {} @id = extract_id(args, ) @data = .delete(:data) @client = .delete(:client) || Client.new() @waiter_block_warned = false end |
Instance Method Details
#ami_launch_index ⇒ Integer
The AMI launch index, which can be used to find this instance in the launch group.
41 42 43 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 41 def ami_launch_index data[:ami_launch_index] end |
#architecture ⇒ String
The architecture of the image.
172 173 174 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 172 def architecture data[:architecture] end |
#attach_classic_link_vpc(options = {}) ⇒ Types::AttachClassicLinkVpcResult
650 651 652 653 654 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 650 def attach_classic_link_vpc( = {}) = .merge(instance_id: @id) resp = @client.attach_classic_link_vpc() resp.data end |
#attach_volume(options = {}) ⇒ Types::VolumeAttachment
675 676 677 678 679 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 675 def attach_volume( = {}) = .merge(instance_id: @id) resp = @client.attach_volume() resp.data end |
#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>
Any block device mapping entries for the instance.
178 179 180 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 178 def block_device_mappings data[:block_device_mappings] end |
#boot_mode ⇒ String
The boot mode of the instance. For more information, see Boot modes in the Amazon EC2 User Guide.
348 349 350 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 348 def boot_mode data[:boot_mode] end |
#capacity_reservation_id ⇒ String
The ID of the Capacity Reservation.
306 307 308 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 306 def capacity_reservation_id data[:capacity_reservation_id] end |
#capacity_reservation_specification ⇒ Types::CapacityReservationSpecificationResponse
Information about the Capacity Reservation targeting option.
312 313 314 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 312 def capacity_reservation_specification data[:capacity_reservation_specification] end |
#classic_address ⇒ ClassicAddress?
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1420 def classic_address if data[:public_ip_address] ClassicAddress.new( public_ip: data[:public_ip_address], client: @client ) else nil end end |
#client ⇒ Client
414 415 416 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 414 def client @client end |
#client_token ⇒ String
The idempotency token you provided when you launched the instance, if applicable.
185 186 187 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 185 def client_token data[:client_token] end |
#console_output(options = {}) ⇒ Types::GetConsoleOutputResult
698 699 700 701 702 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 698 def console_output( = {}) = .merge(instance_id: @id) resp = @client.get_console_output() resp.data end |
#cpu_options ⇒ Types::CpuOptions
The CPU options for the instance.
300 301 302 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 300 def data[:cpu_options] end |
#create_image(options = {}) ⇒ Image
793 794 795 796 797 798 799 800 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 793 def create_image( = {}) = .merge(instance_id: @id) resp = @client.create_image() Image.new( id: resp.data.image_id, client: @client ) end |
#create_tags(options = {}) ⇒ Tag::Collection
824 825 826 827 828 829 830 831 832 833 834 835 836 837 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 824 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = @client.() [: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
.
434 435 436 437 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 434 def data load unless @data @data end |
#data_loaded? ⇒ Boolean
442 443 444 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 442 def data_loaded? !!@data end |
#decrypt_windows_password(key_pair_path) ⇒ String
11 12 13 14 15 16 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/customizations/instance.rb', line 11 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 |
#delete_tags(options = {}) ⇒ Tag::Collection
869 870 871 872 873 874 875 876 877 878 879 880 881 882 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 869 def ( = {}) batch = [] = Aws::Util.deep_merge(, resources: [@id]) resp = @client.() [: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 |
#describe_attribute(options = {}) ⇒ Types::InstanceAttribute
901 902 903 904 905 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 901 def describe_attribute( = {}) = .merge(instance_id: @id) resp = @client.describe_instance_attribute() resp.data end |
#detach_classic_link_vpc(options = {}) ⇒ Types::DetachClassicLinkVpcResult
922 923 924 925 926 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 922 def detach_classic_link_vpc( = {}) = .merge(instance_id: @id) resp = @client.detach_classic_link_vpc() resp.data end |
#detach_volume(options = {}) ⇒ Types::VolumeAttachment
956 957 958 959 960 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 956 def detach_volume( = {}) = .merge(instance_id: @id) resp = @client.detach_volume() 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.
195 196 197 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 195 def ebs_optimized data[:ebs_optimized] end |
#elastic_gpu_associations ⇒ Array<Types::ElasticGpuAssociation>
The Elastic GPU associated with the instance.
226 227 228 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 226 def elastic_gpu_associations data[:elastic_gpu_associations] end |
#elastic_inference_accelerator_associations ⇒ Array<Types::ElasticInferenceAcceleratorAssociation>
The elastic inference accelerator associated with the instance.
232 233 234 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 232 def elastic_inference_accelerator_associations data[:elastic_inference_accelerator_associations] end |
#ena_support ⇒ Boolean
Specifies whether enhanced networking with ENA is enabled.
201 202 203 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 201 def ena_support data[:ena_support] end |
#enclave_options ⇒ Types::EnclaveOptions
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
337 338 339 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 337 def data[:enclave_options] end |
#exists?(options = {}) ⇒ Boolean
Returns true
if the Instance exists.
449 450 451 452 453 454 455 456 457 458 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 449 def exists?( = {}) begin wait_until_exists(.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.
318 319 320 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 318 def data[:hibernation_options] end |
#hypervisor ⇒ String
The hypervisor type of the instance. The value xen
is used for both
Xen and Nitro hypervisors.
208 209 210 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 208 def hypervisor data[:hypervisor] end |
#iam_instance_profile ⇒ Types::IamInstanceProfile
The IAM instance profile associated with the instance, if applicable.
214 215 216 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 214 def iam_instance_profile data[:iam_instance_profile] end |
#id ⇒ String Also known as: instance_id
33 34 35 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 33 def id @id end |
#image ⇒ Image?
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1432 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.
47 48 49 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 47 def image_id data[:image_id] end |
#instance_lifecycle ⇒ String
Indicates whether this is a Spot Instance or a Scheduled Instance.
220 221 222 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 220 def instance_lifecycle data[:instance_lifecycle] end |
#instance_type ⇒ String
The instance type.
53 54 55 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 53 def instance_type data[:instance_type] end |
#ipv_6_address ⇒ String
The IPv6 address assigned to the instance.
388 389 390 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 388 def ipv_6_address data[:ipv_6_address] end |
#kernel_id ⇒ String
The kernel associated with this instance, if applicable.
59 60 61 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 59 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.
66 67 68 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 66 def key_name data[:key_name] end |
#key_pair ⇒ KeyPairInfo?
1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1444 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.
72 73 74 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 72 def launch_time data[:launch_time] end |
#licenses ⇒ Array<Types::LicenseConfiguration>
The license configurations for the instance.
324 325 326 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 324 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
424 425 426 427 428 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 424 def load resp = @client.describe_instances(instance_ids: [@id]) @data = resp.reservations[0].instances[0] self end |
#maintenance_options ⇒ Types::InstanceMaintenanceOptions
Provides information on the recovery and maintenance options of your instance.
407 408 409 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 407 def data[:maintenance_options] end |
#metadata_options ⇒ Types::InstanceMetadataOptionsResponse
The metadata options for the instance.
330 331 332 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 330 def data[:metadata_options] end |
#modify_attribute(options = {}) ⇒ EmptyStructure
1117 1118 1119 1120 1121 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1117 def modify_attribute( = {}) = .merge(instance_id: @id) resp = @client.modify_instance_attribute() resp.data end |
#monitor(options = {}) ⇒ Types::MonitorInstancesResult
1135 1136 1137 1138 1139 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1135 def monitor( = {}) = Aws::Util.deep_merge(, instance_ids: [@id]) resp = @client.monitor_instances() resp.data end |
#monitoring ⇒ Types::Monitoring
The monitoring for the instance.
78 79 80 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 78 def monitoring data[:monitoring] end |
#network_interfaces ⇒ NetworkInterface::Collection
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1456 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 |
#outpost_arn ⇒ String
The Amazon Resource Name (ARN) of the Outpost.
238 239 240 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 238 def outpost_arn data[:outpost_arn] end |
#password_data(options = {}) ⇒ Types::GetPasswordDataResult
1153 1154 1155 1156 1157 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1153 def password_data( = {}) = .merge(instance_id: @id) resp = @client.get_password_data() resp.data end |
#placement ⇒ Types::Placement
The location where the instance launched, if applicable.
84 85 86 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 84 def placement data[:placement] end |
#placement_group ⇒ PlacementGroup?
1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1469 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.
90 91 92 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 90 def platform data[:platform] end |
#platform_details ⇒ String
The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
359 360 361 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 359 def platform_details data[:platform_details] 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.
104 105 106 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 104 def private_dns_name data[:private_dns_name] end |
#private_dns_name_options ⇒ Types::PrivateDnsNameOptionsResponse
The options for the instance hostname.
382 383 384 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 382 def data[:private_dns_name_options] end |
#private_ip_address ⇒ String
The private IPv4 address assigned to the instance.
110 111 112 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 110 def private_ip_address data[:private_ip_address] end |
#product_codes ⇒ Array<Types::ProductCode>
The product codes attached to this instance, if applicable.
116 117 118 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 116 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.
125 126 127 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 125 def public_dns_name data[:public_dns_name] end |
#public_ip_address ⇒ String
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
135 136 137 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 135 def public_ip_address data[:public_ip_address] end |
#ramdisk_id ⇒ String
The RAM disk associated with this instance, if applicable.
141 142 143 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 141 def ramdisk_id data[:ramdisk_id] end |
#reboot(options = {}) ⇒ EmptyStructure
1171 1172 1173 1174 1175 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1171 def reboot( = {}) = Aws::Util.deep_merge(, instance_ids: [@id]) resp = @client.reboot_instances() resp.data end |
#report_status(options = {}) ⇒ EmptyStructure
1229 1230 1231 1232 1233 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1229 def report_status( = {}) = Aws::Util.deep_merge(, instances: [@id]) resp = @client.report_instance_status() resp.data end |
#reset_attribute(options = {}) ⇒ EmptyStructure
1253 1254 1255 1256 1257 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1253 def reset_attribute( = {}) = .merge(instance_id: @id) resp = @client.reset_instance_attribute() resp.data end |
#reset_kernel(options = {}) ⇒ EmptyStructure
1271 1272 1273 1274 1275 1276 1277 1278 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1271 def reset_kernel( = {}) = .merge( instance_id: @id, attribute: "kernel" ) resp = @client.reset_instance_attribute() resp.data end |
#reset_ramdisk(options = {}) ⇒ EmptyStructure
1292 1293 1294 1295 1296 1297 1298 1299 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1292 def reset_ramdisk( = {}) = .merge( instance_id: @id, attribute: "ramdisk" ) resp = @client.reset_instance_attribute() resp.data end |
#reset_source_dest_check(options = {}) ⇒ EmptyStructure
1313 1314 1315 1316 1317 1318 1319 1320 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1313 def reset_source_dest_check( = {}) = .merge( instance_id: @id, attribute: "sourceDestCheck" ) resp = @client.reset_instance_attribute() resp.data end |
#root_device_name ⇒ String
The device name of the root device volume (for example, /dev/sda1
).
244 245 246 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 244 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.
251 252 253 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 251 def root_device_type data[:root_device_type] end |
#security_groups ⇒ Array<Types::GroupIdentifier>
The security groups for the instance.
257 258 259 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 257 def security_groups data[:security_groups] end |
#source_dest_check ⇒ Boolean
Indicates whether source/destination checking is enabled.
263 264 265 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 263 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.
269 270 271 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 269 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.
276 277 278 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 276 def sriov_net_support data[:sriov_net_support] end |
#start(options = {}) ⇒ Types::StartInstancesResult
1337 1338 1339 1340 1341 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1337 def start( = {}) = Aws::Util.deep_merge(, instance_ids: [@id]) resp = @client.start_instances() resp.data end |
#state ⇒ Types::InstanceState
The current state of the instance.
147 148 149 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 147 def state data[:state] end |
#state_reason ⇒ Types::StateReason
The reason for the most recent state transition.
282 283 284 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 282 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.
154 155 156 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 154 def state_transition_reason data[:state_transition_reason] end |
#stop(options = {}) ⇒ Types::StopInstancesResult
1375 1376 1377 1378 1379 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1375 def stop( = {}) = Aws::Util.deep_merge(, instance_ids: [@id]) resp = @client.stop_instances() resp.data end |
#subnet ⇒ Subnet?
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1481 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.
160 161 162 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 160 def subnet_id data[:subnet_id] end |
#tags ⇒ Array<Types::Tag>
Any tags assigned to the instance.
288 289 290 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 288 def data[:tags] end |
#terminate(options = {}) ⇒ Types::TerminateInstancesResult
1393 1394 1395 1396 1397 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1393 def terminate( = {}) = Aws::Util.deep_merge(, instance_ids: [@id]) resp = @client.terminate_instances() resp.data end |
#tpm_support ⇒ String
If the instance is configured for NitroTPM support, the value is
v2.0
. For more information, see NitroTPM in the Amazon EC2
User Guide.
400 401 402 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 400 def tpm_support data[:tpm_support] end |
#unmonitor(options = {}) ⇒ Types::UnmonitorInstancesResult
1411 1412 1413 1414 1415 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1411 def unmonitor( = {}) = Aws::Util.deep_merge(, instance_ids: [@id]) resp = @client.unmonitor_instances() resp.data end |
#usage_operation ⇒ String
The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.
370 371 372 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 370 def usage_operation data[:usage_operation] end |
#usage_operation_update_time ⇒ Time
The time that the usage operation was last updated.
376 377 378 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 376 def usage_operation_update_time data[:usage_operation_update_time] end |
#virtualization_type ⇒ String
The virtualization type of the instance.
294 295 296 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 294 def virtualization_type data[:virtualization_type] end |
#volumes(options = {}) ⇒ Volume::Collection
1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1567 def volumes( = {}) batches = Enumerator.new do |y| = Aws::Util.deep_merge(, filters: [{ name: "attachment.instance-id", values: [@id] }]) resp = @client.describe_volumes() 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?
1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1590 def vpc if data[:vpc_id] Vpc.new( id: data[:vpc_id], client: @client ) else nil end end |
#vpc_addresses(options = {}) ⇒ VpcAddress::Collection
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 1664 def vpc_addresses( = {}) batches = Enumerator.new do |y| batch = [] = Aws::Util.deep_merge(, filters: [{ name: "instance-id", values: [@id] }]) resp = @client.describe_addresses() 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.
166 167 168 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 166 def vpc_id data[:vpc_id] end |
#wait_until(options = {}) {|resource| ... } ⇒ Resource
Use [Aws::EC2::Client] #wait_until instead
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() {|resource| condition}
Example
instance.wait_until(max_attempts:10, delay:5) do |instance|
instance.state.name == 'running'
end
Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:
# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}
Callbacks
You can be notified before each polling attempt and before each
delay. If you throw :success
or :failure
from these callbacks,
it will terminate the waiter.
started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
throw :failure if Time.now - started_at > 3600
end
# disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}
Handling Errors
When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.
begin
resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
attempts attempt in seconds invoked before each attempt invoked before each wait
612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 612 def wait_until( = {}, &block) self_copy = self.dup attempts = 0 [:max_attempts] = 10 unless .key?(:max_attempts) [:delay] ||= 10 [:poller] = Proc.new do attempts += 1 if block.call(self_copy) [:success, self_copy] else self_copy.reload unless attempts == [:max_attempts] :retry end end Aws::Waiters::Waiter.new().wait({}) end |
#wait_until_exists(options = {}, &block) ⇒ Instance
466 467 468 469 470 471 472 473 474 475 476 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 466 def wait_until_exists( = {}, &block) , params = () waiter = Waiters::InstanceExists.new() yield_waiter_and_warn(waiter, &block) 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 = {}, &block) ⇒ Instance
484 485 486 487 488 489 490 491 492 493 494 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 484 def wait_until_running( = {}, &block) , params = () waiter = Waiters::InstanceRunning.new() yield_waiter_and_warn(waiter, &block) 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 = {}, &block) ⇒ Instance
502 503 504 505 506 507 508 509 510 511 512 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 502 def wait_until_stopped( = {}, &block) , params = () waiter = Waiters::InstanceStopped.new() yield_waiter_and_warn(waiter, &block) 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 = {}, &block) ⇒ Instance
520 521 522 523 524 525 526 527 528 529 530 |
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/instance.rb', line 520 def wait_until_terminated( = {}, &block) , params = () waiter = Waiters::InstanceTerminated.new() yield_waiter_and_warn(waiter, &block) 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 |