Class: Aws::ComputeOptimizer::Types::PutRecommendationPreferencesRequest

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

Overview

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 to create or update.

Specify the ‘Active` status to activate the preference, or specify `Inactive` to deactivate the preference.

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) 


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

class PutRecommendationPreferencesRequest < Struct.new(
  :resource_type,
  :scope,
  :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

The provider of the external metrics recommendation preference to create or update.

Specify a valid provider in the ‘source` field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.

This preference can only be set for the ‘Ec2Instance` resource type.

For more information, see [External metrics ingestion] in the *Compute Optimizer User Guide*.

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

Returns:



5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

class PutRecommendationPreferencesRequest < Struct.new(
  :resource_type,
  :scope,
  :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 to create or update.

<note markdown=“1”> The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

</note>

Specify the ‘Inactive` status to deactivate the feature, or specify `Active` to activate it.

For more information, see [Inferred workload types] in the *Compute Optimizer User Guide*.

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/inferred-workload-types.html

Returns:

  • (String) 


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

class PutRecommendationPreferencesRequest < Struct.new(
  :resource_type,
  :scope,
  :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. When this preference isn’t specified, we use the default value ‘DAYS_14`.

You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.

<note markdown=“1”> * Amazon EC2 instance lookback preferences can be set at the

organization, account, and resource levels.

  • Auto Scaling group lookback preferences can only be set at the resource level.

</note>

Returns:

  • (String) 


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

class PutRecommendationPreferencesRequest < Struct.new(
  :resource_type,
  :scope,
  :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::PreferredResource>

The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an ‘includeList` or `excludeList`. If the preference is an empty set of resource type values, an error occurs.

<note markdown=“1”> You can only set this preference for the Amazon EC2 instance and Auto Scaling group resource types.

</note>

Returns:



5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

class PutRecommendationPreferencesRequest < Struct.new(
  :resource_type,
  :scope,
  :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) 


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

class PutRecommendationPreferencesRequest < Struct.new(
  :resource_type,
  :scope,
  :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

The status of the savings estimation mode preference to create or update.

Specify the ‘AfterDiscounts` status to activate the preference, or specify `BeforeDiscounts` to deactivate the preference.

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

For more information, see [ Savings estimation mode] in the *Compute Optimizer User Guide*.

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/savings-estimation-mode.html

Returns:

  • (String) 


5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

class PutRecommendationPreferencesRequest < Struct.new(
  :resource_type,
  :scope,
  :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 to create.

You can create recommendation preferences 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*.

<note markdown=“1”> You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ‘ResourceArn` and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

</note>

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

Returns:



5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

class PutRecommendationPreferencesRequest < Struct.new(
  :resource_type,
  :scope,
  :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. When this preference isn’t specified, we use the following default values.

CPU utilization:

  • ‘P99_5` for threshold

  • ‘PERCENT_20` for headroom

Memory utilization:

  • ‘PERCENT_20` for headroom

^

<note markdown=“1”> * You can only set CPU and memory utilization preferences for the

Amazon EC2 instance resource type.

  • The threshold setting isn’t available for memory utilization.

</note>

Returns:



5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5871

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