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

Interface EffectiveRecommendationPreferences.Builder

All Superinterfaces:

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

Enclosing class:

EffectiveRecommendationPreferences

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

Method Summary

Modifier and Type	Method	Description
EffectiveRecommendationPreferences.Builder	cpuVendorArchitectures(Collection<CpuVendorArchitecture> cpuVendorArchitectures)	Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
EffectiveRecommendationPreferences.Builder	cpuVendorArchitectures(CpuVendorArchitecture... cpuVendorArchitectures)	Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
EffectiveRecommendationPreferences.Builder	cpuVendorArchitecturesWithStrings(String... cpuVendorArchitectures)	Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
EffectiveRecommendationPreferences.Builder	cpuVendorArchitecturesWithStrings(Collection<String> cpuVendorArchitectures)	Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.
EffectiveRecommendationPreferences.Builder	enhancedInfrastructureMetrics(String enhancedInfrastructureMetrics)	Describes the activation status of the enhanced infrastructure metrics preference.
EffectiveRecommendationPreferences.Builder	enhancedInfrastructureMetrics(EnhancedInfrastructureMetrics enhancedInfrastructureMetrics)	Describes the activation status of the enhanced infrastructure metrics preference.
default EffectiveRecommendationPreferences.Builder	externalMetricsPreference(Consumer<ExternalMetricsPreference.Builder> externalMetricsPreference)	An object that describes the external metrics recommendation preference.
EffectiveRecommendationPreferences.Builder	externalMetricsPreference(ExternalMetricsPreference externalMetricsPreference)	An object that describes the external metrics recommendation preference.
EffectiveRecommendationPreferences.Builder	inferredWorkloadTypes(String inferredWorkloadTypes)	Describes the activation status of the inferred workload types preference.
EffectiveRecommendationPreferences.Builder	inferredWorkloadTypes(InferredWorkloadTypesPreference inferredWorkloadTypes)	Describes the activation status of the inferred workload types preference.
EffectiveRecommendationPreferences.Builder	lookBackPeriod(String lookBackPeriod)	The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
EffectiveRecommendationPreferences.Builder	lookBackPeriod(LookBackPeriodPreference lookBackPeriod)	The number of days the utilization metrics of the Amazon Web Services resource are analyzed.
EffectiveRecommendationPreferences.Builder	preferredResources(Collection<EffectivePreferredResource> preferredResources)	The resource type values that are considered as candidates when generating rightsizing recommendations.
EffectiveRecommendationPreferences.Builder	preferredResources(Consumer<EffectivePreferredResource.Builder>... preferredResources)	The resource type values that are considered as candidates when generating rightsizing recommendations.
EffectiveRecommendationPreferences.Builder	preferredResources(EffectivePreferredResource... preferredResources)	The resource type values that are considered as candidates when generating rightsizing recommendations.
default EffectiveRecommendationPreferences.Builder	savingsEstimationMode(Consumer<InstanceSavingsEstimationMode.Builder> savingsEstimationMode)	Describes the savings estimation mode applied for calculating savings opportunity for a resource.
EffectiveRecommendationPreferences.Builder	savingsEstimationMode(InstanceSavingsEstimationMode savingsEstimationMode)	Describes the savings estimation mode applied for calculating savings opportunity for a resource.
EffectiveRecommendationPreferences.Builder	utilizationPreferences(Collection<UtilizationPreference> utilizationPreferences)	The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.
EffectiveRecommendationPreferences.Builder	utilizationPreferences(Consumer<UtilizationPreference.Builder>... utilizationPreferences)	The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.
EffectiveRecommendationPreferences.Builder	utilizationPreferences(UtilizationPreference... utilizationPreferences)	The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

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 Details

cpuVendorArchitecturesWithStrings

EffectiveRecommendationPreferences.Builder cpuVendorArchitecturesWithStrings(Collection<String> cpuVendorArchitectures)

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

Parameters:

cpuVendorArchitectures - Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

Returns:

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

cpuVendorArchitecturesWithStrings

EffectiveRecommendationPreferences.Builder cpuVendorArchitecturesWithStrings(String... cpuVendorArchitectures)

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

Parameters:

cpuVendorArchitectures - Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

Returns:

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

cpuVendorArchitectures

EffectiveRecommendationPreferences.Builder cpuVendorArchitectures(Collection<CpuVendorArchitecture> cpuVendorArchitectures)

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

Parameters:

cpuVendorArchitectures - Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

Returns:

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

cpuVendorArchitectures

EffectiveRecommendationPreferences.Builder cpuVendorArchitectures(CpuVendorArchitecture... cpuVendorArchitectures)

Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

Parameters:

cpuVendorArchitectures - Describes the CPU vendor and architecture for an instance or Auto Scaling group recommendations.

For example, when you specify AWS_ARM64 with:

• A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.

• A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.

• A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.

Returns:

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

enhancedInfrastructureMetrics

EffectiveRecommendationPreferences.Builder enhancedInfrastructureMetrics(String enhancedInfrastructureMetrics)

Describes the activation status of the enhanced infrastructure metrics preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

Parameters:

enhancedInfrastructureMetrics - Describes the activation status of the enhanced infrastructure metrics preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

Returns:

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

See Also:

• EnhancedInfrastructureMetrics
• EnhancedInfrastructureMetrics

enhancedInfrastructureMetrics

EffectiveRecommendationPreferences.Builder enhancedInfrastructureMetrics(EnhancedInfrastructureMetrics enhancedInfrastructureMetrics)

Describes the activation status of the enhanced infrastructure metrics preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

Parameters:

enhancedInfrastructureMetrics - Describes the activation status of the enhanced infrastructure metrics preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh, and a status of Inactive confirms that it's not yet applied to recommendations.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

Returns:

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

See Also:

• EnhancedInfrastructureMetrics
• EnhancedInfrastructureMetrics

inferredWorkloadTypes

EffectiveRecommendationPreferences.Builder inferredWorkloadTypes(String inferredWorkloadTypes)

Describes the activation status of the inferred workload types preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not yet applied to recommendations.

Parameters:

inferredWorkloadTypes - Describes the activation status of the inferred workload types preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not yet applied to recommendations.

Returns:

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

See Also:

• InferredWorkloadTypesPreference
• InferredWorkloadTypesPreference

inferredWorkloadTypes

EffectiveRecommendationPreferences.Builder inferredWorkloadTypes(InferredWorkloadTypesPreference inferredWorkloadTypes)

Describes the activation status of the inferred workload types preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not yet applied to recommendations.

Parameters:

inferredWorkloadTypes - Describes the activation status of the inferred workload types preference.

A status of Active confirms that the preference is applied in the latest recommendation refresh. A status of Inactive confirms that it's not yet applied to recommendations.

Returns:

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

See Also:

• InferredWorkloadTypesPreference
• InferredWorkloadTypesPreference

externalMetricsPreference

EffectiveRecommendationPreferences.Builder externalMetricsPreference(ExternalMetricsPreference externalMetricsPreference)

An object that describes the external metrics recommendation preference.

If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.

Parameters:

externalMetricsPreference - An object that describes the external metrics recommendation preference.

If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.

Returns:

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

externalMetricsPreference

default EffectiveRecommendationPreferences.Builder externalMetricsPreference(Consumer<ExternalMetricsPreference.Builder> externalMetricsPreference)

An object that describes the external metrics recommendation preference.

If the preference is applied in the latest recommendation refresh, an object with a valid source value appears in the response. If the preference isn't applied to the recommendations already, then this object doesn't appear in the response.

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

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

Parameters:

externalMetricsPreference - a consumer that will call methods on ExternalMetricsPreference.Builder

Returns:

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

See Also:

• externalMetricsPreference(ExternalMetricsPreference)

lookBackPeriod

EffectiveRecommendationPreferences.Builder lookBackPeriod(String lookBackPeriod)

The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

Parameters:

lookBackPeriod - The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

Returns:

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

See Also:

• LookBackPeriodPreference
• LookBackPeriodPreference

lookBackPeriod

EffectiveRecommendationPreferences.Builder lookBackPeriod(LookBackPeriodPreference lookBackPeriod)

The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

Parameters:

lookBackPeriod - The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

Returns:

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

See Also:

• LookBackPeriodPreference
• LookBackPeriodPreference

utilizationPreferences

EffectiveRecommendationPreferences.Builder utilizationPreferences(Collection<UtilizationPreference> utilizationPreferences)

The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

This preference is only available for the Amazon EC2 instance resource type.

Parameters:

utilizationPreferences - The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

This preference is only available for the Amazon EC2 instance resource type.

Returns:

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

utilizationPreferences

EffectiveRecommendationPreferences.Builder utilizationPreferences(UtilizationPreference... utilizationPreferences)

The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

This preference is only available for the Amazon EC2 instance resource type.

Parameters:

utilizationPreferences - The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

This preference is only available for the Amazon EC2 instance resource type.

Returns:

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

utilizationPreferences

EffectiveRecommendationPreferences.Builder utilizationPreferences(Consumer<UtilizationPreference.Builder>... utilizationPreferences)

The resource’s CPU and memory utilization preferences, such as threshold and headroom, that are used to generate rightsizing recommendations.

This preference is only available for the Amazon EC2 instance resource type.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to utilizationPreferences(List<UtilizationPreference>).

Parameters:

utilizationPreferences - a consumer that will call methods on UtilizationPreference.Builder

Returns:

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

See Also:

• utilizationPreferences(java.util.Collection<UtilizationPreference>)

preferredResources

EffectiveRecommendationPreferences.Builder preferredResources(Collection<EffectivePreferredResource> preferredResources)

The resource type values that are considered as candidates when generating rightsizing recommendations.

Parameters:

preferredResources - The resource type values that are considered as candidates when generating rightsizing recommendations.

Returns:

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

preferredResources

EffectiveRecommendationPreferences.Builder preferredResources(EffectivePreferredResource... preferredResources)

The resource type values that are considered as candidates when generating rightsizing recommendations.

Parameters:

preferredResources - The resource type values that are considered as candidates when generating rightsizing recommendations.

Returns:

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

preferredResources

EffectiveRecommendationPreferences.Builder preferredResources(Consumer<EffectivePreferredResource.Builder>... preferredResources)

The resource type values that are considered as candidates when generating rightsizing recommendations.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to preferredResources(List<EffectivePreferredResource>).

Parameters:

preferredResources - a consumer that will call methods on EffectivePreferredResource.Builder

Returns:

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

See Also:

• preferredResources(java.util.Collection<EffectivePreferredResource>)

savingsEstimationMode

EffectiveRecommendationPreferences.Builder savingsEstimationMode(InstanceSavingsEstimationMode savingsEstimationMode)

Describes the savings estimation mode applied for calculating savings opportunity for a resource.

Parameters:

savingsEstimationMode - Describes the savings estimation mode applied for calculating savings opportunity for a resource.

Returns:

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

savingsEstimationMode

default EffectiveRecommendationPreferences.Builder savingsEstimationMode(Consumer<InstanceSavingsEstimationMode.Builder> savingsEstimationMode)

Describes the savings estimation mode applied for calculating savings opportunity for a resource.

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

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

Parameters:

savingsEstimationMode - a consumer that will call methods on InstanceSavingsEstimationMode.Builder

Returns:

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

See Also:

• savingsEstimationMode(InstanceSavingsEstimationMode)