Class Host

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

An ESXi host that runs on an Amazon EC2 bare metal instance. Four hosts are created in an Amazon EVS environment during environment creation. You can add hosts to an environment using the CreateEnvironmentHost operation. Amazon EVS supports 4-16 hosts per environment.

See Also:

  • Method Details

    • hostName

      public final String hostName()

      The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.

      Returns:
      The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.

    • ipAddress

      public final String ipAddress()

      The IP address of the host.

      Returns:
      The IP address of the host.

    • keyName

      public final String keyName()

      The name of the SSH key that is used to access the host.

      Returns:
      The name of the SSH key that is used to access the host.

    • instanceType

      public final InstanceType instanceType()

      The EC2 instance type of the host.

      EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

      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 EC2 instance type of the host.

      EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The EC2 instance type of the host.

      EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

      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 EC2 instance type of the host.

      EC2 instances created through Amazon EVS do not support associating an IAM instance profile.

      See Also:

    • placementGroupId

      public final String placementGroupId()

      The unique ID of the placement group where the host is placed.

      Returns:
      The unique ID of the placement group where the host is placed.

    • dedicatedHostId

      public final String dedicatedHostId()

      The unique ID of the Amazon EC2 Dedicated Host.

      Returns:
      The unique ID of the Amazon EC2 Dedicated Host.

    • createdAt

      public final Instant createdAt()

      The date and time that the host was created.

      Returns:
      The date and time that the host was created.

    • modifiedAt

      public final Instant modifiedAt()

      The date and time that the host was modified.

      Returns:
      The date and time that the host was modified.

    • hostState

      public final HostState hostState()

      The state of the host.

      If the service returns an enum value that is not available in the current SDK version, hostState will return HostState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hostStateAsString().

      Returns:
      The state of the host.
      See Also:

    • hostStateAsString

      public final String hostStateAsString()

      The state of the host.

      If the service returns an enum value that is not available in the current SDK version, hostState will return HostState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hostStateAsString().

      Returns:
      The state of the host.
      See Also:

    • stateDetails

      public final String stateDetails()

      A detailed description of the hostState of a host.

      Returns:
      A detailed description of the hostState of a host.

    • ec2InstanceId

      public final String ec2InstanceId()

      The unique ID of the EC2 instance that represents the host.

      Returns:
      The unique ID of the EC2 instance that represents the host.

    • hasNetworkInterfaces

      public final boolean hasNetworkInterfaces()
      For responses, this returns true if the service returned a value for the NetworkInterfaces 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.

    • networkInterfaces

      public final List<NetworkInterface> networkInterfaces()

      The elastic network interfaces that are attached to the host.

      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 hasNetworkInterfaces() method.

      Returns:
      The elastic network interfaces that are attached to the host.

    • toBuilder

      public Host.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<Host.Builder,Host>
      Returns:
      a builder for type T

    • builder

      public static Host.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Host.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.