software.amazon.awssdk.services.computeoptimizer.model

Class AutoScalingGroupRecommendationOption

java.lang.Object

software.amazon.awssdk.services.computeoptimizer.model.AutoScalingGroupRecommendationOption

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutoScalingGroupRecommendationOption.Builder,AutoScalingGroupRecommendationOption>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AutoScalingGroupRecommendationOption.Builder

Method Summary

Modifier and Type	Method and Description
static AutoScalingGroupRecommendationOption.Builder	builder()
AutoScalingGroupConfiguration	configuration() An array of objects that describe an Auto Scaling group configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProjectedUtilizationMetrics() For responses, this returns true if the service returned a value for the ProjectedUtilizationMetrics property.
MigrationEffort	migrationEffort() The level of effort required to migrate from the current instance type to the recommended instance type.
String	migrationEffortAsString() The level of effort required to migrate from the current instance type to the recommended instance type.
Double	performanceRisk() The performance risk of the Auto Scaling group configuration recommendation.
List<UtilizationMetric>	projectedUtilizationMetrics() An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
Integer	rank() The rank of the Auto Scaling group recommendation option.
SavingsOpportunity	savingsOpportunity() An object that describes the savings opportunity for the Auto Scaling group recommendation option.
List<SdkField<?>>	sdkFields()
static Class<? extends AutoScalingGroupRecommendationOption.Builder>	serializableBuilderClass()
AutoScalingGroupRecommendationOption.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

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.

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:

MigrationEffort

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:

MigrationEffort

toBuilder

public AutoScalingGroupRecommendationOption.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AutoScalingGroupRecommendationOption.Builder,AutoScalingGroupRecommendationOption>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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