Instance (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.ec2.model.Instance

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Instance.Builder,Instance>

@Generated(value="software.amazon.awssdk:codegen")
public final class Instance
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Instance.Builder,Instance>

Describes an instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Instance.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Instance.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`amiLaunchIndex()` The AMI launch index, which can be used to find this instance in the launch group.
`ArchitectureValues`	`architecture()` The architecture of the image.
`String`	`architectureAsString()` The architecture of the image.
`List<InstanceBlockDeviceMapping>`	`blockDeviceMappings()` Any block device mapping entries for the instance.
`static Instance.Builder`	`builder()`
`String`	`capacityReservationId()` The ID of the Capacity Reservation.
`CapacityReservationSpecificationResponse`	`capacityReservationSpecification()` Information about the Capacity Reservation targeting option.
`String`	`clientToken()` The idempotency token you provided when you launched the instance, if applicable.
`CpuOptions`	`cpuOptions()` The CPU options for the instance.
`Boolean`	`ebsOptimized()` Indicates whether the instance is optimized for Amazon EBS I/O.
`List<ElasticGpuAssociation>`	`elasticGpuAssociations()` The Elastic GPU associated with the instance.
`List<ElasticInferenceAcceleratorAssociation>`	`elasticInferenceAcceleratorAssociations()` The elastic inference accelerator associated with the instance.
`Boolean`	`enaSupport()` Specifies whether enhanced networking with ENA is enabled.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`HibernationOptions`	`hibernationOptions()` Indicates whether the instance is enabled for hibernation.
`HypervisorType`	`hypervisor()` The hypervisor type of the instance.
`String`	`hypervisorAsString()` The hypervisor type of the instance.
`IamInstanceProfile`	`iamInstanceProfile()` The IAM instance profile associated with the instance, if applicable.
`String`	`imageId()` The ID of the AMI used to launch the instance.
`String`	`instanceId()` The ID of the instance.
`InstanceLifecycleType`	`instanceLifecycle()` Indicates whether this is a Spot Instance or a Scheduled Instance.
`String`	`instanceLifecycleAsString()` Indicates whether this is a Spot Instance or a Scheduled Instance.
`InstanceType`	`instanceType()` The instance type.
`String`	`instanceTypeAsString()` The instance type.
`String`	`kernelId()` The kernel associated with this instance, if applicable.
`String`	`keyName()` The name of the key pair, if this instance was launched with an associated key pair.
`Instant`	`launchTime()` The time the instance was launched.
`List<LicenseConfiguration>`	`licenses()` The license configurations.
`Monitoring`	`monitoring()` The monitoring for the instance.
`List<InstanceNetworkInterface>`	`networkInterfaces()` [EC2-VPC] One or more network interfaces for the instance.
`Placement`	`placement()` The location where the instance launched, if applicable.
`PlatformValues`	`platform()` The value is `Windows` for Windows instances; otherwise blank.
`String`	`platformAsString()` The value is `Windows` for Windows instances; otherwise blank.
`String`	`privateDnsName()` (IPv4 only) The private DNS hostname name assigned to the instance.
`String`	`privateIpAddress()` The private IPv4 address assigned to the instance.
`List<ProductCode>`	`productCodes()` The product codes attached to this instance, if applicable.
`String`	`publicDnsName()` (IPv4 only) The public DNS name assigned to the instance.
`String`	`publicIpAddress()` The public IPv4 address assigned to the instance, if applicable.
`String`	`ramdiskId()` The RAM disk associated with this instance, if applicable.
`String`	`rootDeviceName()` The device name of the root device volume (for example, `/dev/sda1`).
`DeviceType`	`rootDeviceType()` The root device type used by the AMI.
`String`	`rootDeviceTypeAsString()` The root device type used by the AMI.
`List<SdkField<?>>`	`sdkFields()`
`List<GroupIdentifier>`	`securityGroups()` One or more security groups for the instance.
`static Class<? extends Instance.Builder>`	`serializableBuilderClass()`
`Boolean`	`sourceDestCheck()` Specifies whether to enable an instance launched in a VPC to perform NAT.
`String`	`spotInstanceRequestId()` If the request is a Spot Instance request, the ID of the request.
`String`	`sriovNetSupport()` Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
`InstanceState`	`state()` The current state of the instance.
`StateReason`	`stateReason()` The reason for the most recent state transition.
`String`	`stateTransitionReason()` The reason for the most recent state transition.
`String`	`subnetId()` [EC2-VPC] The ID of the subnet in which the instance is running.
`List<Tag>`	`tags()` Any tags assigned to the instance.
`Instance.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`VirtualizationType`	`virtualizationType()` The virtualization type of the instance.
`String`	`virtualizationTypeAsString()` The virtualization type of the instance.
`String`	`vpcId()` [EC2-VPC] The ID of the VPC in which the instance is running.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - amiLaunchIndex
```
public Integer amiLaunchIndex()
```
    The AMI launch index, which can be used to find this instance in the launch group.
    
    Returns:
    
    The AMI launch index, which can be used to find this instance in the launch group.
  - imageId
```
public String imageId()
```
    The ID of the AMI used to launch the instance.
    
    Returns:
    
    The ID of the AMI used to launch the instance.
  - instanceId
```
public String instanceId()
```
    The ID of the instance.
    
    Returns:
    
    The ID of the instance.
  - instanceType
```
public InstanceType instanceType()
```
    The instance type.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    Returns:
    
    The instance type.
    
    See Also:
    
    InstanceType
  - instanceTypeAsString
```
public String instanceTypeAsString()
```
    The instance type.
    
    If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().
    
    Returns:
    
    The instance type.
    
    See Also:
    
    InstanceType
  - kernelId
```
public String kernelId()
```
    The kernel associated with this instance, if applicable.
    
    Returns:
    
    The kernel associated with this instance, if applicable.
  - keyName
```
public String keyName()
```
    The name of the key pair, if this instance was launched with an associated key pair.
    
    Returns:
    
    The name of the key pair, if this instance was launched with an associated key pair.
  - launchTime
```
public Instant launchTime()
```
    The time the instance was launched.
    
    Returns:
    
    The time the instance was launched.
  - monitoring
```
public Monitoring monitoring()
```
    The monitoring for the instance.
    
    Returns:
    
    The monitoring for the instance.
  - placement
```
public Placement placement()
```
    The location where the instance launched, if applicable.
    
    Returns:
    
    The location where the instance launched, if applicable.
  - platform
```
public PlatformValues platform()
```
    The value is Windows for Windows instances; otherwise blank.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return PlatformValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The value is Windows for Windows instances; otherwise blank.
    
    See Also:
    
    PlatformValues
  - platformAsString
```
public String platformAsString()
```
    The value is Windows for Windows instances; otherwise blank.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return PlatformValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The value is Windows for Windows instances; otherwise blank.
    
    See Also:
    
    PlatformValues
  - privateDnsName
```
public String privateDnsName()
```
    (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:
    
    (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.
  - privateIpAddress
```
public String privateIpAddress()
```
    The private IPv4 address assigned to the instance.
    
    Returns:
    
    The private IPv4 address assigned to the instance.
  - productCodes
```
public List<ProductCode> productCodes()
```
    The product codes attached to this instance, if applicable.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The product codes attached to this instance, if applicable.
  - publicDnsName
```
public String publicDnsName()
```
    (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:
    
    (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.
  - publicIpAddress
```
public String publicIpAddress()
```
    The public IPv4 address assigned to the instance, if applicable.
    
    Returns:
    
    The public IPv4 address assigned to the instance, if applicable.
  - ramdiskId
```
public String ramdiskId()
```
    The RAM disk associated with this instance, if applicable.
    
    Returns:
    
    The RAM disk associated with this instance, if applicable.
  - state
```
public InstanceState state()
```
    The current state of the instance.
    
    Returns:
    
    The current state of the instance.
  - stateTransitionReason
```
public String stateTransitionReason()
```
    The reason for the most recent state transition. This might be an empty string.
    
    Returns:
    
    The reason for the most recent state transition. This might be an empty string.
  - subnetId
```
public String subnetId()
```
    [EC2-VPC] The ID of the subnet in which the instance is running.
    
    Returns:
    
    [EC2-VPC] The ID of the subnet in which the instance is running.
  - vpcId
```
public String vpcId()
```
    [EC2-VPC] The ID of the VPC in which the instance is running.
    
    Returns:
    
    [EC2-VPC] The ID of the VPC in which the instance is running.
  - architecture
```
public ArchitectureValues architecture()
```
    The architecture of the image.
    
    If the service returns an enum value that is not available in the current SDK version, architecture will return ArchitectureValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from architectureAsString().
    
    Returns:
    
    The architecture of the image.
    
    See Also:
    
    ArchitectureValues
  - architectureAsString
```
public String architectureAsString()
```
    The architecture of the image.
    
    If the service returns an enum value that is not available in the current SDK version, architecture will return ArchitectureValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from architectureAsString().
    
    Returns:
    
    The architecture of the image.
    
    See Also:
    
    ArchitectureValues
  - blockDeviceMappings
```
public List<InstanceBlockDeviceMapping> blockDeviceMappings()
```
    Any block device mapping entries for the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Any block device mapping entries for the instance.
  - clientToken
```
public String clientToken()
```
    The idempotency token you provided when you launched the instance, if applicable.
    
    Returns:
    
    The idempotency token you provided when you launched the instance, if applicable.
  - ebsOptimized
```
public Boolean ebsOptimized()
```
    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:
    
    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.
  - enaSupport
```
public Boolean enaSupport()
```
    Specifies whether enhanced networking with ENA is enabled.
    
    Returns:
    
    Specifies whether enhanced networking with ENA is enabled.
  - hypervisor
```
public HypervisorType hypervisor()
```
    The hypervisor type of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, hypervisor will return HypervisorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hypervisorAsString().
    
    Returns:
    
    The hypervisor type of the instance.
    
    See Also:
    
    HypervisorType
  - hypervisorAsString
```
public String hypervisorAsString()
```
    The hypervisor type of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, hypervisor will return HypervisorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hypervisorAsString().
    
    Returns:
    
    The hypervisor type of the instance.
    
    See Also:
    
    HypervisorType
  - iamInstanceProfile
```
public IamInstanceProfile iamInstanceProfile()
```
    The IAM instance profile associated with the instance, if applicable.
    
    Returns:
    
    The IAM instance profile associated with the instance, if applicable.
  - instanceLifecycle
```
public InstanceLifecycleType instanceLifecycle()
```
    Indicates whether this is a Spot Instance or a Scheduled Instance.
    
    If the service returns an enum value that is not available in the current SDK version, instanceLifecycle will return InstanceLifecycleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceLifecycleAsString().
    
    Returns:
    
    Indicates whether this is a Spot Instance or a Scheduled Instance.
    
    See Also:
    
    InstanceLifecycleType
  - instanceLifecycleAsString
```
public String instanceLifecycleAsString()
```
    Indicates whether this is a Spot Instance or a Scheduled Instance.
    
    If the service returns an enum value that is not available in the current SDK version, instanceLifecycle will return InstanceLifecycleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceLifecycleAsString().
    
    Returns:
    
    Indicates whether this is a Spot Instance or a Scheduled Instance.
    
    See Also:
    
    InstanceLifecycleType
  - elasticGpuAssociations
```
public List<ElasticGpuAssociation> elasticGpuAssociations()
```
    The Elastic GPU associated with the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The Elastic GPU associated with the instance.
  - elasticInferenceAcceleratorAssociations
```
public List<ElasticInferenceAcceleratorAssociation> elasticInferenceAcceleratorAssociations()
```
    The elastic inference accelerator associated with the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The elastic inference accelerator associated with the instance.
  - networkInterfaces
```
public List<InstanceNetworkInterface> networkInterfaces()
```
    [EC2-VPC] One or more network interfaces for the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    [EC2-VPC] One or more network interfaces for the instance.
  - rootDeviceName
```
public String rootDeviceName()
```
    The device name of the root device volume (for example, /dev/sda1).
    
    Returns:
    
    The device name of the root device volume (for example, /dev/sda1).
  - rootDeviceType
```
public DeviceType rootDeviceType()
```
    The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
    
    If the service returns an enum value that is not available in the current SDK version, rootDeviceType will return DeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootDeviceTypeAsString().
    
    Returns:
    
    The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
    
    See Also:
    
    DeviceType
  - rootDeviceTypeAsString
```
public String rootDeviceTypeAsString()
```
    The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
    
    If the service returns an enum value that is not available in the current SDK version, rootDeviceType will return DeviceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rootDeviceTypeAsString().
    
    Returns:
    
    The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
    
    See Also:
    
    DeviceType
  - securityGroups
```
public List<GroupIdentifier> securityGroups()
```
    One or more security groups for the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    One or more security groups for the instance.
  - sourceDestCheck
```
public Boolean sourceDestCheck()
```
    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:
    
    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.
  - spotInstanceRequestId
```
public String spotInstanceRequestId()
```
    If the request is a Spot Instance request, the ID of the request.
    
    Returns:
    
    If the request is a Spot Instance request, the ID of the request.
  - sriovNetSupport
```
public String sriovNetSupport()
```
    Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
    
    Returns:
    
    Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
  - stateReason
```
public StateReason stateReason()
```
    The reason for the most recent state transition.
    
    Returns:
    
    The reason for the most recent state transition.
  - tags
```
public List<Tag> tags()
```
    Any tags assigned to the instance.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Any tags assigned to the instance.
  - virtualizationType
```
public VirtualizationType virtualizationType()
```
    The virtualization type of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, virtualizationType will return VirtualizationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from virtualizationTypeAsString().
    
    Returns:
    
    The virtualization type of the instance.
    
    See Also:
    
    VirtualizationType
  - virtualizationTypeAsString
```
public String virtualizationTypeAsString()
```
    The virtualization type of the instance.
    
    If the service returns an enum value that is not available in the current SDK version, virtualizationType will return VirtualizationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from virtualizationTypeAsString().
    
    Returns:
    
    The virtualization type of the instance.
    
    See Also:
    
    VirtualizationType
  - cpuOptions
```
public CpuOptions cpuOptions()
```
    The CPU options for the instance.
    
    Returns:
    
    The CPU options for the instance.
  - capacityReservationId
```
public String capacityReservationId()
```
    The ID of the Capacity Reservation.
    
    Returns:
    
    The ID of the Capacity Reservation.
  - capacityReservationSpecification
```
public CapacityReservationSpecificationResponse capacityReservationSpecification()
```
    Information about the Capacity Reservation targeting option.
    
    Returns:
    
    Information about the Capacity Reservation targeting option.
  - hibernationOptions
```
public HibernationOptions hibernationOptions()
```
    Indicates whether the instance is enabled for hibernation.
    
    Returns:
    
    Indicates whether the instance is enabled for hibernation.
  - licenses
```
public List<LicenseConfiguration> licenses()
```
    The license configurations.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The license configurations.
  - toBuilder
```
public Instance.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Instance.Builder,Instance>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Instance.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Instance.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class Instance

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

amiLaunchIndex

imageId

instanceId

instanceType

instanceTypeAsString

kernelId

keyName

launchTime

monitoring

placement

platform

platformAsString

privateDnsName

privateIpAddress

productCodes

publicDnsName

publicIpAddress

ramdiskId

state

stateTransitionReason

subnetId

vpcId

architecture

architectureAsString

blockDeviceMappings

clientToken

ebsOptimized

enaSupport

hypervisor

hypervisorAsString

iamInstanceProfile

instanceLifecycle

instanceLifecycleAsString

elasticGpuAssociations

elasticInferenceAcceleratorAssociations

networkInterfaces

rootDeviceName

rootDeviceType

rootDeviceTypeAsString

securityGroups

sourceDestCheck

spotInstanceRequestId

sriovNetSupport

stateReason

tags

virtualizationType

virtualizationTypeAsString

cpuOptions

capacityReservationId

capacityReservationSpecification

hibernationOptions

licenses

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields