Class InstanceDefinition

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

This data type is used with the Amazon GameLift Servers FleetIQ and game server groups.

An allowed instance type for a game server group. All game server groups must have at least two instance types defined for it. Amazon GameLift Servers FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.

See Also:

  • Method Details

    • instanceType

      public final GameServerGroupInstanceType instanceType()

      An Amazon EC2 instance type designation.

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

      Returns:
      An Amazon EC2 instance type designation.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      An Amazon EC2 instance type designation.

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

      Returns:
      An Amazon EC2 instance type designation.
      See Also:

    • weightedCapacity

      public final String weightedCapacity()

      Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon GameLift Servers FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value is "1".

      Returns:
      Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon GameLift Servers FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see Instance Weighting in the Amazon Elastic Compute Cloud Auto Scaling User Guide. Default value is "1".

    • toBuilder

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

    • builder

      public static InstanceDefinition.Builder builder()

    • serializableBuilderClass

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