Class: Aws::ComputeOptimizer::Types::RecommendationPreferencesDetail

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-computeoptimizer/types.rb

Overview

Describes a recommendation preference.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enhanced_infrastructure_metrics ⇒ String

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

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html

Returns:

  • (String) 


6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#external_metrics_preference ⇒ Types::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:



6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#inferred_workload_types ⇒ String

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:

  • (String) 


6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#look_back_period ⇒ String

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:

  • (String) 


6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_resources ⇒ Array<Types::EffectivePreferredResource>

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:



6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

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:

  • (String) 


6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#savings_estimation_mode ⇒ String

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:

  • (String) 


6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ Types::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*.

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html

Returns:



6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end

#utilization_preferences ⇒ Array<Types::UtilizationPreference>

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

<note markdown=“1”> This preference is only available for the Amazon EC2 instance resource type.

</note>

Returns:



6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 6666

class RecommendationPreferencesDetail < Struct.new(
  :scope,
  :resource_type,
  :enhanced_infrastructure_metrics,
  :inferred_workload_types,
  :external_metrics_preference,
  :look_back_period,
  :utilization_preferences,
  :preferred_resources,
  :savings_estimation_mode)
  SENSITIVE = []
  include Aws::Structure
end