Class InstanceAccess

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

Information and credentials that you can use to remotely connect to an instance in an EC2 managed fleet. This data type is returned in response to a call to GetInstanceAccess.

See Also:

  • Method Details

    • fleetId

      public final String fleetId()

      A unique identifier for the fleet containing the instance to be accessed.

      Returns:
      A unique identifier for the fleet containing the instance to be accessed.

    • instanceId

      public final String instanceId()

      A unique identifier for the instance to be accessed.

      Returns:
      A unique identifier for the instance to be accessed.

    • ipAddress

      public final String ipAddress()

      IP address assigned to the instance.

      Returns:
      IP address assigned to the instance.

    • operatingSystem

      public final OperatingSystem operatingSystem()

      Operating system that is running on the instance.

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

      Returns:
      Operating system that is running on the instance.
      See Also:

    • operatingSystemAsString

      public final String operatingSystemAsString()

      Operating system that is running on the instance.

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

      Returns:
      Operating system that is running on the instance.
      See Also:

    • credentials

      public final InstanceCredentials credentials()

      Security credentials that are required to access the instance.

      Returns:
      Security credentials that are required to access the instance.

    • toBuilder

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

    • builder

      public static InstanceAccess.Builder builder()

    • serializableBuilderClass

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