Class AutoScalingGroupRecommendationOption

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

Describes a recommendation option for an Auto Scaling group.

See Also:

  • Method Details

    • configuration

      public final AutoScalingGroupConfiguration configuration()

      An array of objects that describe an Auto Scaling group configuration.

      Returns:
      An array of objects that describe an Auto Scaling group configuration.

    • instanceGpuInfo

      public final GpuInfo instanceGpuInfo()

      Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.

      Returns:
      Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.

    • hasProjectedUtilizationMetrics

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

    • projectedUtilizationMetrics

      public final List<UtilizationMetric> projectedUtilizationMetrics()

      An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.

      The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

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

      Returns:
      An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.

      The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

    • performanceRisk

      public final Double performanceRisk()

      The performance risk of the Auto Scaling group configuration recommendation.

      Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

      The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

      Returns:
      The performance risk of the Auto Scaling group configuration recommendation.

      Performance risk indicates the likelihood of the recommended instance type not meeting the resource needs of your workload. Compute Optimizer calculates an individual performance risk score for each specification of the recommended instance, including CPU, memory, EBS throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS. The performance risk of the recommended instance is calculated as the maximum performance risk score across the analyzed resource specifications.

      The value ranges from 0 - 4, with 0 meaning that the recommended resource is predicted to always provide enough hardware capability. The higher the performance risk is, the more likely you should validate whether the recommendation will meet the performance requirements of your workload before migrating your resource.

    • rank

      public final Integer rank()

      The rank of the Auto Scaling group recommendation option.

      The top recommendation option is ranked as 1.

      Returns:
      The rank of the Auto Scaling group recommendation option.

      The top recommendation option is ranked as 1.

    • savingsOpportunity

      public final SavingsOpportunity savingsOpportunity()

      An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

      Returns:
      An object that describes the savings opportunity for the Auto Scaling group recommendation option. Savings opportunity includes the estimated monthly savings amount and percentage.

    • savingsOpportunityAfterDiscounts

      public final AutoScalingGroupSavingsOpportunityAfterDiscounts savingsOpportunityAfterDiscounts()

      An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.

      Returns:
      An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts. Savings opportunity includes the estimated monthly savings and percentage.

    • migrationEffort

      public final MigrationEffort migrationEffort()

      The level of effort required to migrate from the current instance type to the recommended instance type.

      For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.

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

      Returns:
      The level of effort required to migrate from the current instance type to the recommended instance type.

      For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.

      See Also:

    • migrationEffortAsString

      public final String migrationEffortAsString()

      The level of effort required to migrate from the current instance type to the recommended instance type.

      For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.

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

      Returns:
      The level of effort required to migrate from the current instance type to the recommended instance type.

      For example, the migration effort is Low if Amazon EMR is the inferred workload type and an Amazon Web Services Graviton instance type is recommended. The migration effort is Medium if a workload type couldn't be inferred but an Amazon Web Services Graviton instance type is recommended. The migration effort is VeryLow if both the current and recommended instance types are of the same CPU architecture.

      See Also:

    • toBuilder

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

    • builder

      public static AutoScalingGroupRecommendationOption.Builder builder()

    • serializableBuilderClass

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