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.

Instance Attribute Summary collapse

Instance Attribute Details

#ami_launch_indexInteger

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.

#architectureString

The architecture of the image.

Possible values:

  • i386
  • x86_64

Returns:

  • (String)

    The architecture of the image.

#block_device_mappingsArray<Types::InstanceBlockDeviceMapping>

Any block device mapping entries for the instance.

Returns:

#client_tokenString

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.

#ebs_optimizedBoolean

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_associationsArray<Types::ElasticGpuAssociation>

The Elastic GPU associated with the instance.

Returns:

#ena_supportBoolean

Specifies whether enhanced networking with ENA is enabled.

Returns:

  • (Boolean)

    Specifies whether enhanced networking with ENA is enabled.

#hypervisorString

The hypervisor type of the instance.

Possible values:

  • ovm
  • xen

Returns:

  • (String)

    The hypervisor type of the instance.

#iam_instance_profileTypes::IamInstanceProfile

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

Returns:

#image_idString

The ID of the AMI used to launch the instance.

Returns:

  • (String)

    The ID of the AMI used to launch the instance.

#instance_idString

The ID of the instance.

Returns:

  • (String)

    The ID of the instance.

#instance_lifecycleString

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_typeString

The instance type.

Possible values:

  • t1.micro
  • t2.nano
  • t2.micro
  • t2.small
  • t2.medium
  • t2.large
  • t2.xlarge
  • t2.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
  • x1.16xlarge
  • x1.32xlarge
  • x1e.32xlarge
  • i2.xlarge
  • i2.2xlarge
  • i2.4xlarge
  • i2.8xlarge
  • i3.large
  • i3.xlarge
  • i3.2xlarge
  • i3.4xlarge
  • i3.8xlarge
  • i3.16xlarge
  • 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
  • cc1.4xlarge
  • cc2.8xlarge
  • g2.2xlarge
  • g2.8xlarge
  • g3.4xlarge
  • g3.8xlarge
  • g3.16xlarge
  • cg1.4xlarge
  • p2.xlarge
  • p2.8xlarge
  • p2.16xlarge
  • d2.xlarge
  • d2.2xlarge
  • d2.4xlarge
  • d2.8xlarge
  • f1.2xlarge
  • f1.16xlarge

Returns:

  • (String)

    The instance type.

#kernel_idString

The kernel associated with this instance, if applicable.

Returns:

  • (String)

    The kernel associated with this instance, if applicable.

#key_nameString

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_timeTime

The time the instance was launched.

Returns:

  • (Time)

    The time the instance was launched.

#monitoringTypes::Monitoring

The monitoring for the instance.

Returns:

#network_interfacesArray<Types::InstanceNetworkInterface>

[EC2-VPC] One or more network interfaces for the instance.

Returns:

#placementTypes::Placement

The location where the instance launched, if applicable.

Returns:

  • (Types::Placement)

    The location where the instance launched, if applicable.

#platformString

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_nameString

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

The private IPv4 address assigned to the instance.

Returns:

  • (String)

    The private IPv4 address assigned to the instance.

#product_codesArray<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_nameString

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

The public IPv4 address assigned to the instance, if applicable.

Returns:

  • (String)

    The public IPv4 address assigned to the instance, if applicable.

#ramdisk_idString

The RAM disk associated with this instance, if applicable.

Returns:

  • (String)

    The RAM disk associated with this instance, if applicable.

#root_device_nameString

The root device name (for example, /dev/sda1 or /dev/xvda).

Returns:

  • (String)

    The root device name (for example, /dev/sda1 or /dev/xvda).

#root_device_typeString

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_groupsArray<Types::GroupIdentifier>

One or more security groups for the instance.

Returns:

#source_dest_checkBoolean

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_idString

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_supportString

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.

#stateTypes::InstanceState

The current state of the instance.

Returns:

#state_reasonTypes::StateReason

The reason for the most recent state transition.

Returns:

#state_transition_reasonString

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_idString

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

#tagsArray<Types::Tag>

Any tags assigned to the instance.

Returns:

  • (Array<Types::Tag>)

    Any tags assigned to the instance.

#virtualization_typeString

The virtualization type of the instance.

Possible values:

  • hvm
  • paravirtual

Returns:

  • (String)

    The virtualization type of the instance.

#vpc_idString

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