Class PerformanceFactorReferenceRequest

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

Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture.

Currently, only one instance family can be specified in the list.

See Also:

  • Method Details

    • instanceFamily

      public final String instanceFamily()

      The instance family to use as a baseline reference.

      Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.

      The following instance families are not supported for performance protection:

      • c1

      • g3 | g3s

      • hpc7g

      • m1 | m2

      • mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro

      • p3dn | p4d | p5

      • t1

      • u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb

      If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.

      If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest.

      Returns:
      The instance family to use as a baseline reference.

      Ensure that you specify the correct value for the instance family. The instance family is everything before the period (.) in the instance type name. For example, in the instance type c6i.large, the instance family is c6i, not c6. For more information, see Amazon EC2 instance type naming conventions in Amazon EC2 Instance Types.

      The following instance families are not supported for performance protection:

      • c1

      • g3 | g3s

      • hpc7g

      • m1 | m2

      • mac1 | mac2 | mac2-m1ultra | mac2-m2 | mac2-m2pro

      • p3dn | p4d | p5

      • t1

      • u-12tb1 | u-18tb1 | u-24tb1 | u-3tb1 | u-6tb1 | u-9tb1 | u7i-12tb | u7in-16tb | u7in-24tb | u7in-32tb

      If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.

      If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for GetInstanceTypesFromInstanceRequirements and an exception for CreateFleet, RequestSpotFleet, ModifyFleet, and ModifySpotFleetRequest.

    • toBuilder

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

    • builder

      public static PerformanceFactorReferenceRequest.Builder builder()

    • serializableBuilderClass

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