Class AutoScalingGroupRecommendation
- java.lang.Object
-
- software.amazon.awssdk.services.computeoptimizer.model.AutoScalingGroupRecommendation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AutoScalingGroupRecommendation.Builder,AutoScalingGroupRecommendation>
@Generated("software.amazon.awssdk:codegen") public final class AutoScalingGroupRecommendation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutoScalingGroupRecommendation.Builder,AutoScalingGroupRecommendation>
Describes an Auto Scaling group recommendation.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAutoScalingGroupRecommendation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringaccountId()The Amazon Web Services account ID of the Auto Scaling group.StringautoScalingGroupArn()The Amazon Resource Name (ARN) of the Auto Scaling group.StringautoScalingGroupName()The name of the Auto Scaling group.static AutoScalingGroupRecommendation.Builderbuilder()AutoScalingGroupConfigurationcurrentConfiguration()An array of objects that describe the current configuration of the Auto Scaling group.GpuInfocurrentInstanceGpuInfo()Describes the GPU accelerator settings for the current instance type of the Auto Scaling group.CurrentPerformanceRiskcurrentPerformanceRisk()The risk of the current Auto Scaling group not meeting the performance needs of its workloads.StringcurrentPerformanceRiskAsString()The risk of the current Auto Scaling group not meeting the performance needs of its workloads.EffectiveRecommendationPreferenceseffectiveRecommendationPreferences()An object that describes the effective recommendation preferences for the Auto Scaling group.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Findingfinding()The finding classification of the Auto Scaling group.StringfindingAsString()The finding classification of the Auto Scaling group.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasInferredWorkloadTypes()For responses, this returns true if the service returned a value for the InferredWorkloadTypes property.booleanhasRecommendationOptions()For responses, this returns true if the service returned a value for the RecommendationOptions property.booleanhasUtilizationMetrics()For responses, this returns true if the service returned a value for the UtilizationMetrics property.List<InferredWorkloadType>inferredWorkloadTypes()The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.List<String>inferredWorkloadTypesAsStrings()The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.InstantlastRefreshTimestamp()The timestamp of when the Auto Scaling group recommendation was last generated.DoublelookBackPeriodInDays()The number of days for which utilization metrics were analyzed for the Auto Scaling group.List<AutoScalingGroupRecommendationOption>recommendationOptions()An array of objects that describe the recommendation options for the Auto Scaling group.List<SdkField<?>>sdkFields()static Class<? extends AutoScalingGroupRecommendation.Builder>serializableBuilderClass()AutoScalingGroupRecommendation.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<UtilizationMetric>utilizationMetrics()An array of objects that describe the utilization metrics of the Auto Scaling group.-
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
-
accountId
public final String accountId()
The Amazon Web Services account ID of the Auto Scaling group.
- Returns:
- The Amazon Web Services account ID of the Auto Scaling group.
-
autoScalingGroupArn
public final String autoScalingGroupArn()
The Amazon Resource Name (ARN) of the Auto Scaling group.
- Returns:
- The Amazon Resource Name (ARN) of the Auto Scaling group.
-
autoScalingGroupName
public final String autoScalingGroupName()
The name of the Auto Scaling group.
- Returns:
- The name of the Auto Scaling group.
-
finding
public final Finding finding()
The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
-
NotOptimized—An Auto Scaling group is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload. -
Optimized—An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
If the service returns an enum value that is not available in the current SDK version,
findingwill returnFinding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfindingAsString().- Returns:
- The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
-
NotOptimized—An Auto Scaling group is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload. -
Optimized—An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
-
- See Also:
Finding
-
-
findingAsString
public final String findingAsString()
The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
-
NotOptimized—An Auto Scaling group is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload. -
Optimized—An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
If the service returns an enum value that is not available in the current SDK version,
findingwill returnFinding.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromfindingAsString().- Returns:
- The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
-
NotOptimized—An Auto Scaling group is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload. -
Optimized—An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
-
- See Also:
Finding
-
-
hasUtilizationMetrics
public final boolean hasUtilizationMetrics()
For responses, this returns true if the service returned a value for the UtilizationMetrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
utilizationMetrics
public final List<UtilizationMetric> utilizationMetrics()
An array of objects that describe the utilization metrics of the Auto Scaling group.
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
hasUtilizationMetrics()method.- Returns:
- An array of objects that describe the utilization metrics of the Auto Scaling group.
-
lookBackPeriodInDays
public final Double lookBackPeriodInDays()
The number of days for which utilization metrics were analyzed for the Auto Scaling group.
- Returns:
- The number of days for which utilization metrics were analyzed for the Auto Scaling group.
-
currentConfiguration
public final AutoScalingGroupConfiguration currentConfiguration()
An array of objects that describe the current configuration of the Auto Scaling group.
- Returns:
- An array of objects that describe the current configuration of the Auto Scaling group.
-
hasRecommendationOptions
public final boolean hasRecommendationOptions()
For responses, this returns true if the service returned a value for the RecommendationOptions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
recommendationOptions
public final List<AutoScalingGroupRecommendationOption> recommendationOptions()
An array of objects that describe the recommendation options for the Auto Scaling group.
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
hasRecommendationOptions()method.- Returns:
- An array of objects that describe the recommendation options for the Auto Scaling group.
-
lastRefreshTimestamp
public final Instant lastRefreshTimestamp()
The timestamp of when the Auto Scaling group recommendation was last generated.
- Returns:
- The timestamp of when the Auto Scaling group recommendation was last generated.
-
currentPerformanceRisk
public final CurrentPerformanceRisk currentPerformanceRisk()
The risk of the current Auto Scaling group not meeting the performance needs of its workloads. The higher the risk, the more likely the current Auto Scaling group configuration has insufficient capacity and cannot meet workload requirements.
If the service returns an enum value that is not available in the current SDK version,
currentPerformanceRiskwill returnCurrentPerformanceRisk.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcurrentPerformanceRiskAsString().- Returns:
- The risk of the current Auto Scaling group not meeting the performance needs of its workloads. The higher the risk, the more likely the current Auto Scaling group configuration has insufficient capacity and cannot meet workload requirements.
- See Also:
CurrentPerformanceRisk
-
currentPerformanceRiskAsString
public final String currentPerformanceRiskAsString()
The risk of the current Auto Scaling group not meeting the performance needs of its workloads. The higher the risk, the more likely the current Auto Scaling group configuration has insufficient capacity and cannot meet workload requirements.
If the service returns an enum value that is not available in the current SDK version,
currentPerformanceRiskwill returnCurrentPerformanceRisk.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcurrentPerformanceRiskAsString().- Returns:
- The risk of the current Auto Scaling group not meeting the performance needs of its workloads. The higher the risk, the more likely the current Auto Scaling group configuration has insufficient capacity and cannot meet workload requirements.
- See Also:
CurrentPerformanceRisk
-
effectiveRecommendationPreferences
public final EffectiveRecommendationPreferences effectiveRecommendationPreferences()
An object that describes the effective recommendation preferences for the Auto Scaling group.
- Returns:
- An object that describes the effective recommendation preferences for the Auto Scaling group.
-
inferredWorkloadTypes
public final List<InferredWorkloadType> inferredWorkloadTypes()
The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instances:
-
AmazonEmr- Infers that Amazon EMR might be running on the instances. -
ApacheCassandra- Infers that Apache Cassandra might be running on the instances. -
ApacheHadoop- Infers that Apache Hadoop might be running on the instances. -
Memcached- Infers that Memcached might be running on the instances. -
NGINX- Infers that NGINX might be running on the instances. -
PostgreSql- Infers that PostgreSQL might be running on the instances. -
Redis- Infers that Redis might be running on the instances. -
Kafka- Infers that Kafka might be running on the instance. -
SQLServer- Infers that SQLServer might be running on the instance.
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
hasInferredWorkloadTypes()method.- Returns:
- The applications that might be running on the instances in the Auto Scaling group as inferred by Compute
Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instances:
-
AmazonEmr- Infers that Amazon EMR might be running on the instances. -
ApacheCassandra- Infers that Apache Cassandra might be running on the instances. -
ApacheHadoop- Infers that Apache Hadoop might be running on the instances. -
Memcached- Infers that Memcached might be running on the instances. -
NGINX- Infers that NGINX might be running on the instances. -
PostgreSql- Infers that PostgreSQL might be running on the instances. -
Redis- Infers that Redis might be running on the instances. -
Kafka- Infers that Kafka might be running on the instance. -
SQLServer- Infers that SQLServer might be running on the instance.
-
-
-
hasInferredWorkloadTypes
public final boolean hasInferredWorkloadTypes()
For responses, this returns true if the service returned a value for the InferredWorkloadTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
inferredWorkloadTypesAsStrings
public final List<String> inferredWorkloadTypesAsStrings()
The applications that might be running on the instances in the Auto Scaling group as inferred by Compute Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instances:
-
AmazonEmr- Infers that Amazon EMR might be running on the instances. -
ApacheCassandra- Infers that Apache Cassandra might be running on the instances. -
ApacheHadoop- Infers that Apache Hadoop might be running on the instances. -
Memcached- Infers that Memcached might be running on the instances. -
NGINX- Infers that NGINX might be running on the instances. -
PostgreSql- Infers that PostgreSQL might be running on the instances. -
Redis- Infers that Redis might be running on the instances. -
Kafka- Infers that Kafka might be running on the instance. -
SQLServer- Infers that SQLServer might be running on the instance.
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
hasInferredWorkloadTypes()method.- Returns:
- The applications that might be running on the instances in the Auto Scaling group as inferred by Compute
Optimizer.
Compute Optimizer can infer if one of the following applications might be running on the instances:
-
AmazonEmr- Infers that Amazon EMR might be running on the instances. -
ApacheCassandra- Infers that Apache Cassandra might be running on the instances. -
ApacheHadoop- Infers that Apache Hadoop might be running on the instances. -
Memcached- Infers that Memcached might be running on the instances. -
NGINX- Infers that NGINX might be running on the instances. -
PostgreSql- Infers that PostgreSQL might be running on the instances. -
Redis- Infers that Redis might be running on the instances. -
Kafka- Infers that Kafka might be running on the instance. -
SQLServer- Infers that SQLServer might be running on the instance.
-
-
-
currentInstanceGpuInfo
public final GpuInfo currentInstanceGpuInfo()
Describes the GPU accelerator settings for the current instance type of the Auto Scaling group.
- Returns:
- Describes the GPU accelerator settings for the current instance type of the Auto Scaling group.
-
toBuilder
public AutoScalingGroupRecommendation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AutoScalingGroupRecommendation.Builder,AutoScalingGroupRecommendation>
-
builder
public static AutoScalingGroupRecommendation.Builder builder()
-
serializableBuilderClass
public static Class<? extends AutoScalingGroupRecommendation.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-