Class Instance

java.lang.Object
software.amazon.awssdk.services.snowdevicemanagement.model.Instance
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Instance.Builder,Instance>
@Generated("software.amazon.awssdk:codegen") public final class Instance extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Instance.Builder,Instance>

The description of an instance. Currently, Amazon EC2 instances are the only supported instance type.

See Also:

  • Method Details

    • amiLaunchIndex

      public final Integer amiLaunchIndex()

      The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.

      Returns:
      The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.

    • hasBlockDeviceMappings

      public final boolean hasBlockDeviceMappings()
      For responses, this returns true if the service returned a value for the BlockDeviceMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blockDeviceMappings

      public final 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.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockDeviceMappings() method.

      Returns:
      Any block device mapping entries for the instance.

    • cpuOptions

      public final CpuOptions cpuOptions()

      The CPU options for the instance.

      Returns:
      The CPU options for the instance.

    • createdAt

      public final Instant createdAt()

      When the instance was created.

      Returns:
      When the instance was created.

    • imageId

      public final 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 final String instanceId()

      The ID of the instance.

      Returns:
      The ID of the instance.

    • instanceType

      public final String instanceType()

      The instance type.

      Returns:
      The instance type.

    • privateIpAddress

      public final String privateIpAddress()

      The private IPv4 address assigned to the instance.

      Returns:
      The private IPv4 address assigned to the instance.

    • publicIpAddress

      public final String publicIpAddress()

      The public IPv4 address assigned to the instance.

      Returns:
      The public IPv4 address assigned to the instance.

    • rootDeviceName

      public final 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).

    • hasSecurityGroups

      public final boolean hasSecurityGroups()
      For responses, this returns true if the service returned a value for the SecurityGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • securityGroups

      public final List<SecurityGroupIdentifier> securityGroups()

      The security groups for the instance.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSecurityGroups() method.

      Returns:
      The security groups for the instance.

    • state

      public final InstanceState state()
      Returns the value of the State property for this object.
      Returns:
      The value of the State property for this object.

    • updatedAt

      public final Instant updatedAt()

      When the instance was last updated.

      Returns:
      When the instance was last updated.

    • 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 final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.