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) 


22
23
24
25
26
27
28
 
# File 'lib/aws-sdk-ec2/instance.rb', line 22

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @id = extract_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Instance Method Details

#ami_launch_index ⇒ Integer

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

Returns:

  • (Integer) 


366
367
368
 
# File 'lib/aws-sdk-ec2/instance.rb', line 366

def ami_launch_index
  data[:ami_launch_index]
end

#architecture ⇒ String

The architecture of the image.

Returns:

  • (String) 


40
41
42
 
# File 'lib/aws-sdk-ec2/instance.rb', line 40

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,
  vpc_id: "VpcId", # required
  groups: ["SecurityGroupId"], # 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 ClassicLink-enabled VPC.

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

    The IDs of the security groups. You cannot specify security groups from a different VPC.

Returns:



700
701
702
703
704
705
706
 
# File 'lib/aws-sdk-ec2/instance.rb', line 700

def attach_classic_link_vpc(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.attach_classic_link_vpc(options)
  end
  resp.data
end

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

Examples:

Request syntax with placeholder values


instance.attach_volume({
  device: "String", # required
  volume_id: "VolumeId", # 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:



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

def attach_volume(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.attach_volume(options)
  end
  resp.data
end

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

Any block device mapping entries for the instance.

Returns:



46
47
48
 
# File 'lib/aws-sdk-ec2/instance.rb', line 46

def block_device_mappings
  data[:block_device_mappings]
end

#boot_mode ⇒ String

The boot mode that was specified by the AMI. If the value is ‘uefi-preferred`, the AMI supports both UEFI and Legacy BIOS. The `currentInstanceBootMode` parameter is the boot mode that is used to boot the instance at launch or start.

<note markdown=“1”> The operating system contained in the AMI must be configured to support the specified boot mode.

</note>

For more information, see [Boot modes] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html

Returns:

  • (String) 


234
235
236
 
# File 'lib/aws-sdk-ec2/instance.rb', line 234

def boot_mode
  data[:boot_mode]
end

#capacity_reservation_id ⇒ String

The ID of the Capacity Reservation.

Returns:

  • (String) 


182
183
184
 
# File 'lib/aws-sdk-ec2/instance.rb', line 182

def capacity_reservation_id
  data[:capacity_reservation_id]
end

#capacity_reservation_specification ⇒ Types::CapacityReservationSpecificationResponse

Information about the Capacity Reservation targeting option.

Returns:



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

def capacity_reservation_specification
  data[:capacity_reservation_specification]
end

#classic_address ⇒ ClassicAddress?

Returns:



1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1533

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:



452
453
454
 
# File 'lib/aws-sdk-ec2/instance.rb', line 452

def client
  @client
end

#client_token ⇒ String

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

Returns:

  • (String) 


53
54
55
 
# File 'lib/aws-sdk-ec2/instance.rb', line 53

def client_token
  data[:client_token]
end

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

Examples:

Request syntax with placeholder values


instance.console_output({
  latest: false,
  dry_run: false,
})

Parameters:

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

    ({})

Options Hash (options):

  • :latest (Boolean) —

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

    Default: disabled (‘false`)

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the operation, 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:



752
753
754
755
756
757
758
 
# File 'lib/aws-sdk-ec2/instance.rb', line 752

def console_output(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_console_output(options)
  end
  resp.data
end

#cpu_options ⇒ Types::CpuOptions

The CPU options for the instance.

Returns:



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

def cpu_options
  data[:cpu_options]
end

#create_image(options = {}) ⇒ Image

Examples:

Request syntax with placeholder values


image = instance.create_image({
  tag_specifications: [
    {
      resource_type: "capacity-reservation", # accepts capacity-reservation, client-vpn-endpoint, customer-gateway, carrier-gateway, coip-pool, declarative-policies-report, dedicated-host, dhcp-options, egress-only-internet-gateway, elastic-ip, elastic-gpu, export-image-task, export-instance-task, fleet, fpga-image, host-reservation, image, import-image-task, import-snapshot-task, instance, instance-event-window, internet-gateway, ipam, ipam-pool, ipam-scope, ipv4pool-ec2, ipv6pool-ec2, key-pair, launch-template, local-gateway, local-gateway-route-table, local-gateway-virtual-interface, local-gateway-virtual-interface-group, local-gateway-route-table-vpc-association, local-gateway-route-table-virtual-interface-group-association, natgateway, network-acl, network-interface, network-insights-analysis, network-insights-path, network-insights-access-scope, network-insights-access-scope-analysis, placement-group, prefix-list, replace-root-volume-task, reserved-instances, route-table, security-group, security-group-rule, snapshot, spot-fleet-request, spot-instances-request, subnet, subnet-cidr-reservation, traffic-mirror-filter, traffic-mirror-session, traffic-mirror-target, transit-gateway, transit-gateway-attachment, transit-gateway-connect-peer, transit-gateway-multicast-domain, transit-gateway-policy-table, transit-gateway-route-table, transit-gateway-route-table-announcement, volume, vpc, vpc-endpoint, vpc-endpoint-connection, vpc-endpoint-service, vpc-endpoint-service-permission, vpc-peering-connection, vpn-connection, vpn-gateway, vpc-flow-log, capacity-reservation-fleet, traffic-mirror-filter-rule, vpc-endpoint-connection-device-type, verified-access-instance, verified-access-group, verified-access-endpoint, verified-access-policy, verified-access-trust-provider, vpn-connection-device-type, vpc-block-public-access-exclusion, ipam-resource-discovery, ipam-resource-discovery-association, instance-connect-endpoint, verified-access-endpoint-target, ipam-external-resource-verification-token
      tags: [
        {
          key: "String",
          value: "String",
        },
      ],
    },
  ],
  dry_run: false,
  name: "String", # required
  description: "String",
  no_reboot: false,
  block_device_mappings: [
    {
      ebs: {
        delete_on_termination: false,
        iops: 1,
        snapshot_id: "SnapshotId",
        volume_size: 1,
        volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
        kms_key_id: "String",
        throughput: 1,
        outpost_arn: "String",
        encrypted: false,
      },
      no_device: "String",
      device_name: "String",
      virtual_name: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :tag_specifications (Array<Types::TagSpecification>) —

    The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

    • To tag the AMI, the value for ‘ResourceType` must be `image`.

    • To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for ‘ResourceType` must be `snapshot`. The same tag is applied to all of the snapshots that are created.

    If you specify other values for ‘ResourceType`, the request fails.

    To tag an AMI or snapshot after it has been created, see [CreateTags].

    [1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.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`.

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

  • :description (String) —

    A description for the new image.

  • :no_reboot (Boolean) —

    Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values:

    • ‘true` - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots.

    • ‘false` - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created.

    Default: ‘false`

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

    The block device mappings.

    When using the CreateImage action:

    • You can’t change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance.

    • You can’t modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), use the CopyImage action.

    • The only option that can be changed for existing mappings or snapshots is ‘DeleteOnTermination`.

Returns:



863
864
865
866
867
868
869
870
871
872
 
# File 'lib/aws-sdk-ec2/instance.rb', line 863

def create_image(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_image(options)
  end
  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>) —

    The tags. The ‘value` parameter is required, but if you don’t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

Returns:



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/aws-sdk-ec2/instance.rb', line 896

def create_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.create_tags(options)
  end
  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

#current_instance_boot_mode ⇒ String

The boot mode that is used to boot the instance at launch or start. For more information, see [Boot modes] in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html

Returns:

  • (String) 


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

def current_instance_boot_mode
  data[:current_instance_boot_mode]
end

#data ⇒ Types::Instance

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

Returns:



474
475
476
477
 
# File 'lib/aws-sdk-ec2/instance.rb', line 474

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.



482
483
484
 
# File 'lib/aws-sdk-ec2/instance.rb', line 482

def data_loaded?
  !!@data
end

#decrypt_windows_password(key_pair_path) ⇒ String

Parameters:

  • key_pair_path (String, Pathname)

Returns:

  • (String) 


11
12
13
14
15
16
 
# File '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

Examples:

Request syntax with placeholder values


tag = instance.delete_tags({
  dry_run: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ‘DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.

  • :tags (Array<Types::Tag>) —

    The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

    If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete Amazon Web Services-generated tags (tags that have the ‘aws:` prefix).

    Constraints: Up to 1000 tags.

Returns:



943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/aws-sdk-ec2/instance.rb', line 943

def delete_tags(options = {})
  batch = []
  options = Aws::Util.deep_merge(options, resources: [@id])
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.delete_tags(options)
  end
  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

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the operation, 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`.

  • :attribute (required, String) —

    The instance attribute.

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

Returns:



977
978
979
980
981
982
983
 
# File 'lib/aws-sdk-ec2/instance.rb', line 977

def describe_attribute(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_instance_attribute(options)
  end
  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: "VpcId", # 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:



1000
1001
1002
1003
1004
1005
1006
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1000

def detach_classic_link_vpc(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.detach_classic_link_vpc(options)
  end
  resp.data
end

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

Examples:

Request syntax with placeholder values


instance.detach_volume({
  device: "String",
  force: false,
  volume_id: "VolumeIdWithResolver", # 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:



1036
1037
1038
1039
1040
1041
1042
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1036

def detach_volume(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.detach_volume(options)
  end
  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) 


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

def ebs_optimized
  data[:ebs_optimized]
end

#elastic_gpu_associations ⇒ Array<Types::ElasticGpuAssociation>

Deprecated.

<note markdown=“1”> Amazon Elastic Graphics reached end of life on January 8, 2024.

</note>

Returns:



98
99
100
 
# File 'lib/aws-sdk-ec2/instance.rb', line 98

def elastic_gpu_associations
  data[:elastic_gpu_associations]
end

#elastic_inference_accelerator_associations ⇒ Array<Types::ElasticInferenceAcceleratorAssociation>

Deprecated

<note markdown=“1”> Amazon Elastic Inference is no longer available.

</note>

Returns:



108
109
110
 
# File 'lib/aws-sdk-ec2/instance.rb', line 108

def elastic_inference_accelerator_associations
  data[:elastic_inference_accelerator_associations]
end

#ena_support ⇒ Boolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean) 


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

def ena_support
  data[:ena_support]
end

#enclave_options ⇒ Types::EnclaveOptions

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

Returns:



213
214
215
 
# File 'lib/aws-sdk-ec2/instance.rb', line 213

def enclave_options
  data[:enclave_options]
end

#exists?(options = {}) ⇒ Boolean

Returns ‘true` if the Instance exists.

Parameters:

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

    ({})

Returns:

  • (Boolean) —

    Returns ‘true` if the Instance exists.



489
490
491
492
493
494
495
496
497
498
 
# File 'lib/aws-sdk-ec2/instance.rb', line 489

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:



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

def hibernation_options
  data[:hibernation_options]
end

#hypervisor ⇒ String

The hypervisor type of the instance. The value ‘xen` is used for both Xen and Nitro hypervisors.

Returns:

  • (String) 


76
77
78
 
# File 'lib/aws-sdk-ec2/instance.rb', line 76

def hypervisor
  data[:hypervisor]
end

#iam_instance_profile ⇒ Types::IamInstanceProfile

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

Returns:



82
83
84
 
# File 'lib/aws-sdk-ec2/instance.rb', line 82

def iam_instance_profile
  data[:iam_instance_profile]
end

#id ⇒ String Also known as: instance_id

Returns:

  • (String) 


33
34
35
 
# File 'lib/aws-sdk-ec2/instance.rb', line 33

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. 


1807
1808
1809
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1807

def identifiers
  { id: @id }
end

#image ⇒ Image?

Returns:



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1545

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) 


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

def image_id
  data[:image_id]
end

#instance_lifecycle ⇒ String

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

Returns:

  • (String) 


88
89
90
 
# File 'lib/aws-sdk-ec2/instance.rb', line 88

def instance_lifecycle
  data[:instance_lifecycle]
end

#instance_type ⇒ String

The instance type.

Returns:

  • (String) 


378
379
380
 
# File 'lib/aws-sdk-ec2/instance.rb', line 378

def instance_type
  data[:instance_type]
end

#ipv_6_address ⇒ String

The IPv6 address assigned to the instance.

Returns:

  • (String) 


274
275
276
 
# File 'lib/aws-sdk-ec2/instance.rb', line 274

def ipv_6_address
  data[:ipv_6_address]
end

#kernel_id ⇒ String

The kernel associated with this instance, if applicable.

Returns:

  • (String) 


398
399
400
 
# File 'lib/aws-sdk-ec2/instance.rb', line 398

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) 


359
360
361
 
# File 'lib/aws-sdk-ec2/instance.rb', line 359

def key_name
  data[:key_name]
end

#key_pair ⇒ KeyPairInfo?

Returns:



1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1557

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

#launch_time ⇒ Time

The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface.

Returns:

  • (Time) 


386
387
388
 
# File 'lib/aws-sdk-ec2/instance.rb', line 386

def launch_time
  data[:launch_time]
end

#licenses ⇒ Array<Types::LicenseConfiguration>

The license configurations for the instance.

Returns:



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

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) 


462
463
464
465
466
467
468
 
# File 'lib/aws-sdk-ec2/instance.rb', line 462

def load
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.describe_instances(instance_ids: [@id])
  end
  @data = resp.reservations[0].instances[0]
  self
end

#maintenance_options ⇒ Types::InstanceMaintenanceOptions

Provides information on the recovery and maintenance options of your instance.

Returns:



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

def maintenance_options
  data[:maintenance_options]
end

#metadata_options ⇒ Types::InstanceMetadataOptionsResponse

The metadata options for the instance.

Returns:



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

def metadata_options
  data[:metadata_options]
end

#modify_attribute(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :source_dest_check (Types::AttributeBooleanValue) —

    Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is ‘true`, source/destination checks are enabled; otherwise, they are disabled. The default value is `true`. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.

  • :disable_api_stop (Types::AttributeBooleanValue) —

    Indicates whether an instance is enabled for stop protection. For more information, see [Enable stop protection for your instance].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the operation, 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`.

  • :attribute (String) —

    The name of the attribute to modify.

    You can modify the following attributes only: ‘disableApiTermination` | `instanceType` | `kernel` | `ramdisk` | `instanceInitiatedShutdownBehavior` | `blockDeviceMapping` | `userData` | `sourceDestCheck` | `groupSet` | `ebsOptimized` | `sriovNetSupport` | `enaSupport` | `nvmeSupport` | `disableApiStop` | `enclaveOptions`

  • :value (String) —

    A new value for the attribute. Use only with the ‘kernel`, `ramdisk`, `userData`, `disableApiTermination`, or `instanceInitiatedShutdownBehavior` 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. You can’t modify the ‘DeleteOnTermination` attribute for volumes that are attached to Fargate tasks.

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

    Update the block device mapping when launching an instance][1

    in the

    *Amazon EC2 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.

  • :instance_type (Types::AttributeValue) —

    Changes the instance type to the specified value. For more information, see [Instance types] in the *Amazon EC2 User Guide*. 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

  • :user_data (Types::BlobAttributeValue) —

    Changes the instance’s user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you’re using, the base64-encoding might be performed for you. For more information, see [Work with instance user data].

    [1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html

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

  • :groups (Array<String>) —

    Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it’s just the default security group for the VPC.

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

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

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

Returns:

  • (EmptyStructure) 


1204
1205
1206
1207
1208
1209
1210
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1204

def modify_attribute(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.modify_instance_attribute(options)
  end
  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 operation, 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:



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

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

#monitoring ⇒ Types::Monitoring

The monitoring for the instance.

Returns:



417
418
419
 
# File 'lib/aws-sdk-ec2/instance.rb', line 417

def monitoring
  data[:monitoring]
end

#network_interfaces ⇒ NetworkInterface::Collection

Returns:



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1569

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

#operator ⇒ Types::OperatorResponse

The service provider that manages the instance.

Returns:



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

def operator
  data[:operator]
end

#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (String) 


114
115
116
 
# File 'lib/aws-sdk-ec2/instance.rb', line 114

def outpost_arn
  data[:outpost_arn]
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 operation, 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:



1244
1245
1246
1247
1248
1249
1250
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1244

def password_data(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.get_password_data(options)
  end
  resp.data
end

#placement ⇒ Types::Placement

The location where the instance launched, if applicable.

Returns:



392
393
394
 
# File 'lib/aws-sdk-ec2/instance.rb', line 392

def placement
  data[:placement]
end

#placement_group ⇒ PlacementGroup?

Returns:



1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1582

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

#platform ⇒ String

The platform. This value is ‘windows` for Windows instances; otherwise, it is empty.

Returns:

  • (String) 


411
412
413
 
# File 'lib/aws-sdk-ec2/instance.rb', line 411

def platform
  data[:platform]
end

#platform_details ⇒ String

The platform details value for the instance. For more information, see

AMI billing information fields][1

in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html

Returns:

  • (String) 


245
246
247
 
# File 'lib/aws-sdk-ec2/instance.rb', line 245

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.

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) 


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

def private_dns_name
  data[:private_dns_name]
end

#private_dns_name_options ⇒ Types::PrivateDnsNameOptionsResponse

The options for the instance hostname.

Returns:



268
269
270
 
# File 'lib/aws-sdk-ec2/instance.rb', line 268

def private_dns_name_options
  data[:private_dns_name_options]
end

#private_ip_address ⇒ String

The private IPv4 address assigned to the instance.

Returns:

  • (String) 


435
436
437
 
# File 'lib/aws-sdk-ec2/instance.rb', line 435

def private_ip_address
  data[:private_ip_address]
end

#product_codes ⇒ Array<Types::ProductCode>

The product codes attached to this instance, if applicable.

Returns:



372
373
374
 
# File 'lib/aws-sdk-ec2/instance.rb', line 372

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. This name is only available if you’ve enabled DNS hostnames for your VPC.

Returns:

  • (String) 


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

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.

Returns:

  • (String) 


445
446
447
 
# File 'lib/aws-sdk-ec2/instance.rb', line 445

def public_ip_address
  data[:public_ip_address]
end

#ramdisk_id ⇒ String

The RAM disk associated with this instance, if applicable.

Returns:

  • (String) 


404
405
406
 
# File 'lib/aws-sdk-ec2/instance.rb', line 404

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 operation, 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) 


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

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

#report_status(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


instance.report_status({
  dry_run: false,
  status: "ok", # required, accepts ok, impaired
  start_time: Time.now,
  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
  description: "ReportInstanceStatusRequestDescription",
})

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the operation, 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`.

  • :status (required, String) —

    The status of all instances listed.

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

    The time at which the reported instance health state began.

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

    The time at which the reported instance health state ended.

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

    The 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]

  • :description (String) —

    Descriptive text about the health state of your instance.

Returns:

  • (EmptyStructure) 


1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1324

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

#reset_attribute(options = {}) ⇒ EmptyStructure

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :dry_run (Boolean) —

    Checks whether you have the required permissions for the operation, 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`.

  • :attribute (required, String) —

    The attribute to reset.

    You can only reset the following attributes: ‘kernel` | `ramdisk` | `sourceDestCheck`.

Returns:

  • (EmptyStructure) 


1350
1351
1352
1353
1354
1355
1356
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1350

def reset_attribute(options = {})
  options = options.merge(instance_id: @id)
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.reset_instance_attribute(options)
  end
  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 operation, 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) 


1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1370

def reset_kernel(options = {})
  options = options.merge(
    instance_id: @id,
    attribute: "kernel"
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.reset_instance_attribute(options)
  end
  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 operation, 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) 


1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1393

def reset_ramdisk(options = {})
  options = options.merge(
    instance_id: @id,
    attribute: "ramdisk"
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.reset_instance_attribute(options)
  end
  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 operation, 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) 


1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1416

def reset_source_dest_check(options = {})
  options = options.merge(
    instance_id: @id,
    attribute: "sourceDestCheck"
  )
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.reset_instance_attribute(options)
  end
  resp.data
end

#root_device_name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def root_device_type
  data[:root_device_type]
end

#security_groups ⇒ Array<Types::GroupIdentifier>

The security groups for the instance.

Returns:



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

def security_groups
  data[:security_groups]
end

#source_dest_check ⇒ Boolean

Indicates whether source/destination checking is enabled.

Returns:

  • (Boolean) 


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

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) 


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

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) 


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

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



1442
1443
1444
1445
1446
1447
1448
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1442

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

#state ⇒ Types::InstanceState

The current state of the instance.

Returns:



323
324
325
 
# File 'lib/aws-sdk-ec2/instance.rb', line 323

def state
  data[:state]
end

#state_reason ⇒ Types::StateReason

The reason for the most recent state transition.

Returns:



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

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) 


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

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 EC2 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 operation, 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:



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

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

#subnet ⇒ Subnet?

Returns:



1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1594

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

#subnet_id ⇒ String

The ID of the subnet in which the instance is running.

Returns:

  • (String) 


423
424
425
 
# File 'lib/aws-sdk-ec2/instance.rb', line 423

def subnet_id
  data[:subnet_id]
end

#tags ⇒ Array<Types::Tag>

Any tags assigned to the instance.

Returns:



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

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



1502
1503
1504
1505
1506
1507
1508
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1502

def terminate(options = {})
  options = Aws::Util.deep_merge(options, instance_ids: [@id])
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    @client.terminate_instances(options)
  end
  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*.

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

Returns:

  • (String) 


286
287
288
 
# File 'lib/aws-sdk-ec2/instance.rb', line 286

def tpm_support
  data[:tpm_support]
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 operation, 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:



1522
1523
1524
1525
1526
1527
1528
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1522

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

#usage_operation ⇒ String

The usage operation value for the instance. For more information, see

AMI billing information fields][1

in the *Amazon EC2 User Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html

Returns:

  • (String) 


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

def usage_operation
  data[:usage_operation]
end

#usage_operation_update_time ⇒ Time

The time that the usage operation was last updated.

Returns:

  • (Time) 


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

def usage_operation_update_time
  data[:usage_operation_update_time]
end

#virtualization_type ⇒ String

The virtualization type of the instance.

Returns:

  • (String) 


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

def virtualization_type
  data[:virtualization_type]
end

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

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (options):

  • :volume_ids (Array<String>) —

    The volume IDs. If not specified, then all volumes are included in the response.

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

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

    The 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` - Indicates whether the volume is encrypted (`true` | `false`)

    • ‘fast-restored` - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (`true` | `false`).

    • ‘multi-attach-enabled` - Indicates whether the volume is enabled for Multi-Attach (`true` | `false`)

    • ‘operator.managed` - A Boolean that indicates whether this is a managed volume.

    • ‘operator.principal` - The principal that manages the volume. Only valid for managed volumes, where `managed` is `true`.

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

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

    • ‘status` - The state 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 (`gp2` | `gp3` | `io1` | `io2` | `st1` | `sc1`| `standard`)

Returns:



1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1687

def volumes(options = {})
  batches = Enumerator.new do |y|
    options = Aws::Util.deep_merge(options, filters: [{
      name: "attachment.instance-id",
      values: [@id]
    }])
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_volumes(options)
    end
    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:



1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1712

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({
  public_ips: ["String"],
  dry_run: false,
  filters: [
    {
      name: "String",
      values: ["String"],
    },
  ],
  allocation_ids: ["AllocationId"],
})

Parameters:

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

    ({})

Options Hash (options):

  • :public_ips (Array<String>) —

    One or more Elastic IP addresses.

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

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

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

    • ‘allocation-id` - The allocation ID for the address.

    • ‘association-id` - The association ID for the address.

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

    • ‘network-border-group` - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.

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

    • ‘network-interface-owner-id` - The Amazon Web Services account ID of the owner.

    • ‘private-ip-address` - The private IP address associated with the Elastic IP address.

    • ‘public-ip` - The Elastic IP address, or the carrier 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.

  • :allocation_ids (Array<String>) —

    Information about the allocation IDs.

Returns:



1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/aws-sdk-ec2/instance.rb', line 1783

def vpc_addresses(options = {})
  batches = Enumerator.new do |y|
    batch = []
    options = Aws::Util.deep_merge(options, filters: [{
      name: "instance-id",
      values: [@id]
    }])
    resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
      @client.describe_addresses(options)
    end
    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

The ID of the VPC in which the instance is running.

Returns:

  • (String) 


429
430
431
 
# File 'lib/aws-sdk-ec2/instance.rb', line 429

def vpc_id
  data[:vpc_id]
end

#wait_until(options = {}) {|resource| ... } ⇒ Resource

Deprecated.

Use [Aws::EC2::Client] #wait_until instead

Note:

The waiting operation is performed on a copy. The original resource remains unchanged.

Waiter polls an API operation until a resource enters a desired state.

## Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

## Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to #wait_until:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

## Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

attempts attempt in seconds invoked before each attempt invoked before each wait

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :max_attempts (Integer) — default: 10 —

    Maximum number of

  • :delay (Integer) — default: 10 —

    Delay between each

  • :before_attempt (Proc) — default: nil —

    Callback

  • :before_wait (Proc) — default: nil —

    Callback

Yield Parameters:

  • resource (Resource) —

    to be used in the waiting condition.

Returns:

  • (Resource) —

    if the waiter was successful

Raises:

  • (Aws::Waiters::Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

    yet successful.

  • (Aws::Waiters::Errors::UnexpectedError) —

    Raised when an error is encountered while polling for a resource that is not expected.

  • (NotImplementedError) —

    Raised when the resource does not



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 
# File 'lib/aws-sdk-ec2/instance.rb', line 660

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::Plugins::UserAgent.metric('RESOURCE_MODEL') do
    Aws::Waiters::Waiter.new(options).wait({})
  end
end

#wait_until_exists(options = {}, &block) ⇒ 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:



506
507
508
509
510
511
512
513
514
515
516
517
518
 
# File 'lib/aws-sdk-ec2/instance.rb', line 506

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

#wait_until_running(options = {}, &block) ⇒ 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:



526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/aws-sdk-ec2/instance.rb', line 526

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

#wait_until_stopped(options = {}, &block) ⇒ 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:



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/aws-sdk-ec2/instance.rb', line 546

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

#wait_until_terminated(options = {}, &block) ⇒ 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:



566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/aws-sdk-ec2/instance.rb', line 566

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