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

Interface RecommendationPreferencesDetail.Builder

All Superinterfaces:

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

Enclosing class:

RecommendationPreferencesDetail

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

Method Summary

Modifier and Type	Method	Description
RecommendationPreferencesDetail.Builder	enhancedInfrastructureMetrics(String enhancedInfrastructureMetrics)	The status of the enhanced infrastructure metrics recommendation preference.
RecommendationPreferencesDetail.Builder	enhancedInfrastructureMetrics(EnhancedInfrastructureMetrics enhancedInfrastructureMetrics)	The status of the enhanced infrastructure metrics recommendation preference.
default RecommendationPreferencesDetail.Builder	externalMetricsPreference(Consumer<ExternalMetricsPreference.Builder> externalMetricsPreference)	An object that describes the external metrics recommendation preference.
RecommendationPreferencesDetail.Builder	externalMetricsPreference(ExternalMetricsPreference externalMetricsPreference)	An object that describes the external metrics recommendation preference.
RecommendationPreferencesDetail.Builder	inferredWorkloadTypes(String inferredWorkloadTypes)	The status of the inferred workload types recommendation preference.
RecommendationPreferencesDetail.Builder	inferredWorkloadTypes(InferredWorkloadTypesPreference inferredWorkloadTypes)	The status of the inferred workload types recommendation preference.
RecommendationPreferencesDetail.Builder	lookBackPeriod(String lookBackPeriod)	The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed.
RecommendationPreferencesDetail.Builder	lookBackPeriod(LookBackPeriodPreference lookBackPeriod)	The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed.
RecommendationPreferencesDetail.Builder	preferredResources(Collection<EffectivePreferredResource> preferredResources)	The preference to control which resource type values are considered when generating rightsizing recommendations.
RecommendationPreferencesDetail.Builder	preferredResources(Consumer<EffectivePreferredResource.Builder>... preferredResources)	The preference to control which resource type values are considered when generating rightsizing recommendations.
RecommendationPreferencesDetail.Builder	preferredResources(EffectivePreferredResource... preferredResources)	The preference to control which resource type values are considered when generating rightsizing recommendations.
RecommendationPreferencesDetail.Builder	resourceType(String resourceType)	The target resource type of the recommendation preference to create.
RecommendationPreferencesDetail.Builder	resourceType(ResourceType resourceType)	The target resource type of the recommendation preference to create.
RecommendationPreferencesDetail.Builder	savingsEstimationMode(String savingsEstimationMode)	Describes the savings estimation mode used for calculating savings opportunity.
RecommendationPreferencesDetail.Builder	savingsEstimationMode(SavingsEstimationMode savingsEstimationMode)	Describes the savings estimation mode used for calculating savings opportunity.
default RecommendationPreferencesDetail.Builder	scope(Consumer<Scope.Builder> scope)	An object that describes the scope of the recommendation preference.
RecommendationPreferencesDetail.Builder	scope(Scope scope)	An object that describes the scope of the recommendation preference.
RecommendationPreferencesDetail.Builder	utilizationPreferences(Collection<UtilizationPreference> utilizationPreferences)	The preference to control the resource’s CPU utilization thresholds - threshold and headroom.
RecommendationPreferencesDetail.Builder	utilizationPreferences(Consumer<UtilizationPreference.Builder>... utilizationPreferences)	The preference to control the resource’s CPU utilization thresholds - threshold and headroom.
RecommendationPreferencesDetail.Builder	utilizationPreferences(UtilizationPreference... utilizationPreferences)	The preference to control the resource’s CPU utilization thresholds - threshold and headroom.

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

scope

RecommendationPreferencesDetail.Builder scope(Scope scope)

An object that describes the scope of the recommendation preference.

Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

Parameters:

scope - An object that describes the scope of the recommendation preference.

Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

Returns:

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

scope

default RecommendationPreferencesDetail.Builder scope(Consumer<Scope.Builder> scope)

An object that describes the scope of the recommendation preference.

Recommendation preferences can be created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

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

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

Parameters:

scope - a consumer that will call methods on Scope.Builder

Returns:

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

See Also:

scope(Scope)

resourceType

RecommendationPreferencesDetail.Builder resourceType(String resourceType)

The target resource type of the recommendation preference to create.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

Parameters:

resourceType - The target resource type of the recommendation preference to create.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

Returns:

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

See Also:

ResourceType, ResourceType

resourceType

RecommendationPreferencesDetail.Builder resourceType(ResourceType resourceType)

The target resource type of the recommendation preference to create.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

Parameters:

resourceType - The target resource type of the recommendation preference to create.

The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

Returns:

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

See Also:

ResourceType, ResourceType

enhancedInfrastructureMetrics

RecommendationPreferencesDetail.Builder enhancedInfrastructureMetrics(String enhancedInfrastructureMetrics)

The status of the enhanced infrastructure metrics recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.

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

Parameters:

enhancedInfrastructureMetrics - The status of the enhanced infrastructure metrics recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't 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

RecommendationPreferencesDetail.Builder enhancedInfrastructureMetrics(EnhancedInfrastructureMetrics enhancedInfrastructureMetrics)

The status of the enhanced infrastructure metrics recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.

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

Parameters:

enhancedInfrastructureMetrics - The status of the enhanced infrastructure metrics recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't 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

RecommendationPreferencesDetail.Builder inferredWorkloadTypes(String inferredWorkloadTypes)

The status of the inferred workload types recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.

Parameters:

inferredWorkloadTypes - The status of the inferred workload types recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.

Returns:

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

See Also:

InferredWorkloadTypesPreference, InferredWorkloadTypesPreference

inferredWorkloadTypes

RecommendationPreferencesDetail.Builder inferredWorkloadTypes(InferredWorkloadTypesPreference inferredWorkloadTypes)

The status of the inferred workload types recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.

Parameters:

inferredWorkloadTypes - The status of the inferred workload types recommendation preference.

When the recommendations page is refreshed, a status of Active confirms that the preference is applied to the recommendations, and a status of Inactive confirms that the preference isn't yet applied to recommendations.

Returns:

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

See Also:

InferredWorkloadTypesPreference, InferredWorkloadTypesPreference

externalMetricsPreference

RecommendationPreferencesDetail.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 RecommendationPreferencesDetail.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

RecommendationPreferencesDetail.Builder lookBackPeriod(String lookBackPeriod)

The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.

Parameters:

lookBackPeriod - The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.

Returns:

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

See Also:

LookBackPeriodPreference, LookBackPeriodPreference

lookBackPeriod

RecommendationPreferencesDetail.Builder lookBackPeriod(LookBackPeriodPreference lookBackPeriod)

The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.

Parameters:

lookBackPeriod - The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. If the preference isn’t set, this object is null.

Returns:

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

See Also:

LookBackPeriodPreference, LookBackPeriodPreference

utilizationPreferences

RecommendationPreferencesDetail.Builder utilizationPreferences(Collection<UtilizationPreference> utilizationPreferences)

The preference to control the resource’s CPU utilization thresholds - threshold and headroom. If the preference isn’t set, this object is null.

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

Parameters:

utilizationPreferences - The preference to control the resource’s CPU utilization thresholds - threshold and headroom. If the preference isn’t set, this object is null.

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

RecommendationPreferencesDetail.Builder utilizationPreferences(UtilizationPreference... utilizationPreferences)

The preference to control the resource’s CPU utilization thresholds - threshold and headroom. If the preference isn’t set, this object is null.

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

Parameters:

utilizationPreferences - The preference to control the resource’s CPU utilization thresholds - threshold and headroom. If the preference isn’t set, this object is null.

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

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

The preference to control the resource’s CPU utilization thresholds - threshold and headroom. If the preference isn’t set, this object is null.

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).

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)

preferredResources

RecommendationPreferencesDetail.Builder preferredResources(Collection<EffectivePreferredResource> preferredResources)

The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.

Parameters:

preferredResources - The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.

Returns:

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

preferredResources

RecommendationPreferencesDetail.Builder preferredResources(EffectivePreferredResource... preferredResources)

The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.

Parameters:

preferredResources - The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.

Returns:

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

preferredResources

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

The preference to control which resource type values are considered when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. If the preference isn’t set, this object is null.

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).

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)

savingsEstimationMode

RecommendationPreferencesDetail.Builder savingsEstimationMode(String savingsEstimationMode)

Describes the savings estimation mode used for calculating savings opportunity.

Only the account manager or delegated administrator of your organization can activate this preference.

Parameters:

savingsEstimationMode - Describes the savings estimation mode used for calculating savings opportunity.

Only the account manager or delegated administrator of your organization can activate this preference.

Returns:

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

See Also:

SavingsEstimationMode, SavingsEstimationMode

savingsEstimationMode

RecommendationPreferencesDetail.Builder savingsEstimationMode(SavingsEstimationMode savingsEstimationMode)

Describes the savings estimation mode used for calculating savings opportunity.

Only the account manager or delegated administrator of your organization can activate this preference.

Parameters:

savingsEstimationMode - Describes the savings estimation mode used for calculating savings opportunity.

Only the account manager or delegated administrator of your organization can activate this preference.

Returns:

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

See Also:

SavingsEstimationMode, SavingsEstimationMode