Package software.amazon.awssdk.services.computeoptimizer.model

Interface AutoScalingGroupRecommendationOption.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AutoScalingGroupRecommendationOption.Builder,AutoScalingGroupRecommendationOption>, SdkBuilder<AutoScalingGroupRecommendationOption.Builder,AutoScalingGroupRecommendationOption>, SdkPojo

Enclosing class:

AutoScalingGroupRecommendationOption

public static interface AutoScalingGroupRecommendationOption.Builder
extends SdkPojo, CopyableBuilder<AutoScalingGroupRecommendationOption.Builder,AutoScalingGroupRecommendationOption>

Method Summary

Modifier and Type	Method	Description
default AutoScalingGroupRecommendationOption.Builder	configuration(Consumer<AutoScalingGroupConfiguration.Builder> configuration)	An array of objects that describe an Auto Scaling group configuration.
AutoScalingGroupRecommendationOption.Builder	configuration(AutoScalingGroupConfiguration configuration)	An array of objects that describe an Auto Scaling group configuration.
default AutoScalingGroupRecommendationOption.Builder	instanceGpuInfo(Consumer<GpuInfo.Builder> instanceGpuInfo)	Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.
AutoScalingGroupRecommendationOption.Builder	instanceGpuInfo(GpuInfo instanceGpuInfo)	Describes the GPU accelerator settings for the recommended instance type of the Auto Scaling group.
AutoScalingGroupRecommendationOption.Builder	migrationEffort(String migrationEffort)	The level of effort required to migrate from the current instance type to the recommended instance type.
AutoScalingGroupRecommendationOption.Builder	migrationEffort(MigrationEffort migrationEffort)	The level of effort required to migrate from the current instance type to the recommended instance type.
AutoScalingGroupRecommendationOption.Builder	performanceRisk(Double performanceRisk)	The performance risk of the Auto Scaling group configuration recommendation.
AutoScalingGroupRecommendationOption.Builder	projectedUtilizationMetrics(Collection<UtilizationMetric> projectedUtilizationMetrics)	An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
AutoScalingGroupRecommendationOption.Builder	projectedUtilizationMetrics(Consumer<UtilizationMetric.Builder>... projectedUtilizationMetrics)	An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
AutoScalingGroupRecommendationOption.Builder	projectedUtilizationMetrics(UtilizationMetric... projectedUtilizationMetrics)	An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
AutoScalingGroupRecommendationOption.Builder	rank(Integer rank)	The rank of the Auto Scaling group recommendation option.
default AutoScalingGroupRecommendationOption.Builder	savingsOpportunity(Consumer<SavingsOpportunity.Builder> savingsOpportunity)	An object that describes the savings opportunity for the Auto Scaling group recommendation option.
AutoScalingGroupRecommendationOption.Builder	savingsOpportunity(SavingsOpportunity savingsOpportunity)	An object that describes the savings opportunity for the Auto Scaling group recommendation option.
default AutoScalingGroupRecommendationOption.Builder	savingsOpportunityAfterDiscounts(Consumer<AutoScalingGroupSavingsOpportunityAfterDiscounts.Builder> savingsOpportunityAfterDiscounts)	An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts.
AutoScalingGroupRecommendationOption.Builder	savingsOpportunityAfterDiscounts(AutoScalingGroupSavingsOpportunityAfterDiscounts savingsOpportunityAfterDiscounts)	An object that describes the savings opportunity for the Auto Scaling group recommendation option that includes Savings Plans and Reserved Instances discounts.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

configuration

AutoScalingGroupRecommendationOption.Builder configuration(AutoScalingGroupConfiguration configuration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

configuration

default AutoScalingGroupRecommendationOption.Builder configuration(Consumer<AutoScalingGroupConfiguration.Builder> configuration)

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

This is a convenience method that creates an instance of the AutoScalingGroupConfiguration.Builder avoiding the need to create one manually via AutoScalingGroupConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(AutoScalingGroupConfiguration).

Parameters:

configuration - a consumer that will call methods on AutoScalingGroupConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

configuration(AutoScalingGroupConfiguration)

projectedUtilizationMetrics

AutoScalingGroupRecommendationOption.Builder projectedUtilizationMetrics(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

projectedUtilizationMetrics

AutoScalingGroupRecommendationOption.Builder projectedUtilizationMetrics(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

projectedUtilizationMetrics

AutoScalingGroupRecommendationOption.Builder projectedUtilizationMetrics(Consumer<UtilizationMetric.Builder>... 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.

This is a convenience method that creates an instance of the UtilizationMetric.Builder avoiding the need to create one manually via UtilizationMetric.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #projectedUtilizationMetrics(List).

Parameters:

projectedUtilizationMetrics - a consumer that will call methods on UtilizationMetric.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#projectedUtilizationMetrics(java.util.Collection)

performanceRisk

AutoScalingGroupRecommendationOption.Builder performanceRisk(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

rank

AutoScalingGroupRecommendationOption.Builder rank(Integer rank)

The rank of the Auto Scaling group recommendation option.

The top recommendation option is ranked as 1.

Parameters:

rank - The rank of the Auto Scaling group recommendation option.

The top recommendation option is ranked as 1.

Returns:

Returns a reference to this object so that method calls can be chained together.

savingsOpportunity

AutoScalingGroupRecommendationOption.Builder savingsOpportunity(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

savingsOpportunity

default AutoScalingGroupRecommendationOption.Builder savingsOpportunity(Consumer<SavingsOpportunity.Builder> 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.

This is a convenience method that creates an instance of the SavingsOpportunity.Builder avoiding the need to create one manually via SavingsOpportunity.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to savingsOpportunity(SavingsOpportunity).

Parameters:

savingsOpportunity - a consumer that will call methods on SavingsOpportunity.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

savingsOpportunity(SavingsOpportunity)

migrationEffort

AutoScalingGroupRecommendationOption.Builder migrationEffort(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MigrationEffort, MigrationEffort

migrationEffort

AutoScalingGroupRecommendationOption.Builder migrationEffort(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MigrationEffort, MigrationEffort

instanceGpuInfo

AutoScalingGroupRecommendationOption.Builder instanceGpuInfo(GpuInfo instanceGpuInfo)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceGpuInfo

default AutoScalingGroupRecommendationOption.Builder instanceGpuInfo(Consumer<GpuInfo.Builder> instanceGpuInfo)

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

This is a convenience method that creates an instance of the GpuInfo.Builder avoiding the need to create one manually via GpuInfo.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceGpuInfo(GpuInfo).

Parameters:

instanceGpuInfo - a consumer that will call methods on GpuInfo.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

instanceGpuInfo(GpuInfo)

savingsOpportunityAfterDiscounts

AutoScalingGroupRecommendationOption.Builder savingsOpportunityAfterDiscounts(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

savingsOpportunityAfterDiscounts

default AutoScalingGroupRecommendationOption.Builder savingsOpportunityAfterDiscounts(Consumer<AutoScalingGroupSavingsOpportunityAfterDiscounts.Builder> 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.

This is a convenience method that creates an instance of the AutoScalingGroupSavingsOpportunityAfterDiscounts.Builder avoiding the need to create one manually via AutoScalingGroupSavingsOpportunityAfterDiscounts.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to savingsOpportunityAfterDiscounts(AutoScalingGroupSavingsOpportunityAfterDiscounts).

Parameters:

savingsOpportunityAfterDiscounts - a consumer that will call methods on AutoScalingGroupSavingsOpportunityAfterDiscounts.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

savingsOpportunityAfterDiscounts(AutoScalingGroupSavingsOpportunityAfterDiscounts)