You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::EC2::Types::Instance

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes an instance.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#ami_launch_index ⇒ Integer

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

Returns:

  • (Integer) —

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

#architecture ⇒ String

The architecture of the image.

Possible values:

  • i386
  • x86_64
  • arm64

Returns:

  • (String) —

    The architecture of the image.

#block_device_mappings ⇒ Array<Types::InstanceBlockDeviceMapping>

Any block device mapping entries for the instance.

Returns:

#capacity_reservation_id ⇒ String

The ID of the Capacity Reservation.

Returns:

  • (String) —

    The ID of the Capacity Reservation.

#capacity_reservation_specification ⇒ Types::CapacityReservationSpecificationResponse

Information about the Capacity Reservation targeting option.

Returns:

#client_token ⇒ String

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

Returns:

  • (String) —

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

#cpu_options ⇒ Types::CpuOptions

The CPU options for the instance.

Returns:

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

    Indicates whether the instance is optimized for Amazon EBS I/O.

#elastic_gpu_associations ⇒ Array<Types::ElasticGpuAssociation>

The Elastic GPU associated with the instance.

Returns:

#elastic_inference_accelerator_associations ⇒ Array<Types::ElasticInferenceAcceleratorAssociation>

The elastic inference accelerator associated with the instance.

Returns:

#ena_support ⇒ Boolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean) —

    Specifies whether enhanced networking with ENA is enabled.

#enclave_options ⇒ Types::EnclaveOptions

Indicates whether the instance is enabled for AWS Nitro Enclaves.

Returns:

#hibernation_options ⇒ Types::HibernationOptions

Indicates whether the instance is enabled for hibernation.

Returns:

#hypervisor ⇒ String

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

Possible values:

  • ovm
  • xen

Returns:

  • (String) —

    The hypervisor type of the instance.

#iam_instance_profile ⇒ Types::IamInstanceProfile

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

Returns:

#image_id ⇒ String

The ID of the AMI used to launch the instance.

Returns:

  • (String) —

    The ID of the AMI used to launch the instance.

#instance_id ⇒ String

The ID of the instance.

Returns:

  • (String) —

    The ID of the instance.

#instance_lifecycle ⇒ String

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

Possible values:

  • spot
  • scheduled

Returns:

  • (String) —

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

#instance_type ⇒ String

The instance type.

Possible values:

  • t1.micro
  • t2.nano
  • t2.micro
  • t2.small
  • t2.medium
  • t2.large
  • t2.xlarge
  • t2.2xlarge
  • t3.nano
  • t3.micro
  • t3.small
  • t3.medium
  • t3.large
  • t3.xlarge
  • t3.2xlarge
  • t3a.nano
  • t3a.micro
  • t3a.small
  • t3a.medium
  • t3a.large
  • t3a.xlarge
  • t3a.2xlarge
  • t4g.nano
  • t4g.micro
  • t4g.small
  • t4g.medium
  • t4g.large
  • t4g.xlarge
  • t4g.2xlarge
  • m1.small
  • m1.medium
  • m1.large
  • m1.xlarge
  • m3.medium
  • m3.large
  • m3.xlarge
  • m3.2xlarge
  • m4.large
  • m4.xlarge
  • m4.2xlarge
  • m4.4xlarge
  • m4.10xlarge
  • m4.16xlarge
  • m2.xlarge
  • m2.2xlarge
  • m2.4xlarge
  • cr1.8xlarge
  • r3.large
  • r3.xlarge
  • r3.2xlarge
  • r3.4xlarge
  • r3.8xlarge
  • r4.large
  • r4.xlarge
  • r4.2xlarge
  • r4.4xlarge
  • r4.8xlarge
  • r4.16xlarge
  • r5.large
  • r5.xlarge
  • r5.2xlarge
  • r5.4xlarge
  • r5.8xlarge
  • r5.12xlarge
  • r5.16xlarge
  • r5.24xlarge
  • r5.metal
  • r5a.large
  • r5a.xlarge
  • r5a.2xlarge
  • r5a.4xlarge
  • r5a.8xlarge
  • r5a.12xlarge
  • r5a.16xlarge
  • r5a.24xlarge
  • r5d.large
  • r5d.xlarge
  • r5d.2xlarge
  • r5d.4xlarge
  • r5d.8xlarge
  • r5d.12xlarge
  • r5d.16xlarge
  • r5d.24xlarge
  • r5d.metal
  • r5ad.large
  • r5ad.xlarge
  • r5ad.2xlarge
  • r5ad.4xlarge
  • r5ad.8xlarge
  • r5ad.12xlarge
  • r5ad.16xlarge
  • r5ad.24xlarge
  • r6g.metal
  • r6g.medium
  • r6g.large
  • r6g.xlarge
  • r6g.2xlarge
  • r6g.4xlarge
  • r6g.8xlarge
  • r6g.12xlarge
  • r6g.16xlarge
  • r6gd.metal
  • r6gd.medium
  • r6gd.large
  • r6gd.xlarge
  • r6gd.2xlarge
  • r6gd.4xlarge
  • r6gd.8xlarge
  • r6gd.12xlarge
  • r6gd.16xlarge
  • x1.16xlarge
  • x1.32xlarge
  • x1e.xlarge
  • x1e.2xlarge
  • x1e.4xlarge
  • x1e.8xlarge
  • x1e.16xlarge
  • x1e.32xlarge
  • i2.xlarge
  • i2.2xlarge
  • i2.4xlarge
  • i2.8xlarge
  • i3.large
  • i3.xlarge
  • i3.2xlarge
  • i3.4xlarge
  • i3.8xlarge
  • i3.16xlarge
  • i3.metal
  • i3en.large
  • i3en.xlarge
  • i3en.2xlarge
  • i3en.3xlarge
  • i3en.6xlarge
  • i3en.12xlarge
  • i3en.24xlarge
  • i3en.metal
  • hi1.4xlarge
  • hs1.8xlarge
  • c1.medium
  • c1.xlarge
  • c3.large
  • c3.xlarge
  • c3.2xlarge
  • c3.4xlarge
  • c3.8xlarge
  • c4.large
  • c4.xlarge
  • c4.2xlarge
  • c4.4xlarge
  • c4.8xlarge
  • c5.large
  • c5.xlarge
  • c5.2xlarge
  • c5.4xlarge
  • c5.9xlarge
  • c5.12xlarge
  • c5.18xlarge
  • c5.24xlarge
  • c5.metal
  • c5a.large
  • c5a.xlarge
  • c5a.2xlarge
  • c5a.4xlarge
  • c5a.8xlarge
  • c5a.12xlarge
  • c5a.16xlarge
  • c5a.24xlarge
  • c5ad.large
  • c5ad.xlarge
  • c5ad.2xlarge
  • c5ad.4xlarge
  • c5ad.8xlarge
  • c5ad.12xlarge
  • c5ad.16xlarge
  • c5ad.24xlarge
  • c5d.large
  • c5d.xlarge
  • c5d.2xlarge
  • c5d.4xlarge
  • c5d.9xlarge
  • c5d.12xlarge
  • c5d.18xlarge
  • c5d.24xlarge
  • c5d.metal
  • c5n.large
  • c5n.xlarge
  • c5n.2xlarge
  • c5n.4xlarge
  • c5n.9xlarge
  • c5n.18xlarge
  • c6g.metal
  • c6g.medium
  • c6g.large
  • c6g.xlarge
  • c6g.2xlarge
  • c6g.4xlarge
  • c6g.8xlarge
  • c6g.12xlarge
  • c6g.16xlarge
  • c6gd.metal
  • c6gd.medium
  • c6gd.large
  • c6gd.xlarge
  • c6gd.2xlarge
  • c6gd.4xlarge
  • c6gd.8xlarge
  • c6gd.12xlarge
  • c6gd.16xlarge
  • cc1.4xlarge
  • cc2.8xlarge
  • g2.2xlarge
  • g2.8xlarge
  • g3.4xlarge
  • g3.8xlarge
  • g3.16xlarge
  • g3s.xlarge
  • g4dn.xlarge
  • g4dn.2xlarge
  • g4dn.4xlarge
  • g4dn.8xlarge
  • g4dn.12xlarge
  • g4dn.16xlarge
  • g4dn.metal
  • cg1.4xlarge
  • p2.xlarge
  • p2.8xlarge
  • p2.16xlarge
  • p3.2xlarge
  • p3.8xlarge
  • p3.16xlarge
  • p3dn.24xlarge
  • p4d.24xlarge
  • d2.xlarge
  • d2.2xlarge
  • d2.4xlarge
  • d2.8xlarge
  • f1.2xlarge
  • f1.4xlarge
  • f1.16xlarge
  • m5.large
  • m5.xlarge
  • m5.2xlarge
  • m5.4xlarge
  • m5.8xlarge
  • m5.12xlarge
  • m5.16xlarge
  • m5.24xlarge
  • m5.metal
  • m5a.large
  • m5a.xlarge
  • m5a.2xlarge
  • m5a.4xlarge
  • m5a.8xlarge
  • m5a.12xlarge
  • m5a.16xlarge
  • m5a.24xlarge
  • m5d.large
  • m5d.xlarge
  • m5d.2xlarge
  • m5d.4xlarge
  • m5d.8xlarge
  • m5d.12xlarge
  • m5d.16xlarge
  • m5d.24xlarge
  • m5d.metal
  • m5ad.large
  • m5ad.xlarge
  • m5ad.2xlarge
  • m5ad.4xlarge
  • m5ad.8xlarge
  • m5ad.12xlarge
  • m5ad.16xlarge
  • m5ad.24xlarge
  • h1.2xlarge
  • h1.4xlarge
  • h1.8xlarge
  • h1.16xlarge
  • z1d.large
  • z1d.xlarge
  • z1d.2xlarge
  • z1d.3xlarge
  • z1d.6xlarge
  • z1d.12xlarge
  • z1d.metal
  • u-6tb1.metal
  • u-9tb1.metal
  • u-12tb1.metal
  • u-18tb1.metal
  • u-24tb1.metal
  • a1.medium
  • a1.large
  • a1.xlarge
  • a1.2xlarge
  • a1.4xlarge
  • a1.metal
  • m5dn.large
  • m5dn.xlarge
  • m5dn.2xlarge
  • m5dn.4xlarge
  • m5dn.8xlarge
  • m5dn.12xlarge
  • m5dn.16xlarge
  • m5dn.24xlarge
  • m5n.large
  • m5n.xlarge
  • m5n.2xlarge
  • m5n.4xlarge
  • m5n.8xlarge
  • m5n.12xlarge
  • m5n.16xlarge
  • m5n.24xlarge
  • r5dn.large
  • r5dn.xlarge
  • r5dn.2xlarge
  • r5dn.4xlarge
  • r5dn.8xlarge
  • r5dn.12xlarge
  • r5dn.16xlarge
  • r5dn.24xlarge
  • r5n.large
  • r5n.xlarge
  • r5n.2xlarge
  • r5n.4xlarge
  • r5n.8xlarge
  • r5n.12xlarge
  • r5n.16xlarge
  • r5n.24xlarge
  • inf1.xlarge
  • inf1.2xlarge
  • inf1.6xlarge
  • inf1.24xlarge
  • m6g.metal
  • m6g.medium
  • m6g.large
  • m6g.xlarge
  • m6g.2xlarge
  • m6g.4xlarge
  • m6g.8xlarge
  • m6g.12xlarge
  • m6g.16xlarge
  • m6gd.metal
  • m6gd.medium
  • m6gd.large
  • m6gd.xlarge
  • m6gd.2xlarge
  • m6gd.4xlarge
  • m6gd.8xlarge
  • m6gd.12xlarge
  • m6gd.16xlarge

Returns:

  • (String) —

    The instance type.

#kernel_id ⇒ String

The kernel associated with this instance, if applicable.

Returns:

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

Returns:

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

Returns:

  • (Time) —

    The time the instance was launched.

#licenses ⇒ Array<Types::LicenseConfiguration>

The license configurations.

Returns:

#metadata_options ⇒ Types::InstanceMetadataOptionsResponse

The metadata options for the instance.

Returns:

#monitoring ⇒ Types::Monitoring

The monitoring for the instance.

Returns:

#network_interfaces ⇒ Array<Types::InstanceNetworkInterface>

[EC2-VPC] The network interfaces for the instance.

Returns:

#outpost_arn ⇒ String

The Amazon Resource Name (ARN) of the Outpost.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the Outpost.

#placement ⇒ Types::Placement

The location where the instance launched, if applicable.

Returns:

  • (Types::Placement) —

    The location where the instance launched, if applicable.

#platform ⇒ String

The value is Windows for Windows instances; otherwise blank.

Possible values:

  • Windows

Returns:

  • (String) —

    The value is Windows for Windows instances; otherwise blank.

#private_dns_name ⇒ String

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

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

Returns:

  • (String) —

    (IPv4 only) The private DNS hostname name assigned to the instance.

#private_ip_address ⇒ String

The private IPv4 address assigned to the instance.

Returns:

  • (String) —

    The private IPv4 address assigned to the instance.

#product_codes ⇒ Array<Types::ProductCode>

The product codes attached to this instance, if applicable.

Returns:

  • (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. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you\'ve enabled DNS hostnames for your VPC.

Returns:

  • (String) —

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

A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

Returns:

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

Returns:

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

Returns:

  • (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. The AMI can use an EBS volume or an instance store volume.

Possible values:

  • ebs
  • instance-store

Returns:

  • (String) —

    The root device type used by the AMI.

#security_groups ⇒ Array<Types::GroupIdentifier>

The security groups for the instance.

Returns:

#source_dest_check ⇒ Boolean

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

Returns:

  • (Boolean) —

    Specifies whether to enable an instance launched in a VPC to perform NAT.

#spot_instance_request_id ⇒ String

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

Returns:

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

Returns:

  • (String) —

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

#state ⇒ Types::InstanceState

The current state of the instance.

Returns:

#state_reason ⇒ Types::StateReason

The reason for the most recent state transition.

Returns:

#state_transition_reason ⇒ String

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

Returns:

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

Returns:

  • (String) —

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

#tags ⇒ Array<Types::Tag>

Any tags assigned to the instance.

Returns:

  • (Array<Types::Tag>) —

    Any tags assigned to the instance.

#virtualization_type ⇒ String

The virtualization type of the instance.

Possible values:

  • hvm
  • paravirtual

Returns:

  • (String) —

    The virtualization type of the instance.

#vpc_id ⇒ String

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

Returns:

  • (String) —

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