Class: Aws::ComputeOptimizer::Types::PreferredResource

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

Overview

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. For more information, see [ Rightsizing recommendation preferences] in the *Compute Optimizer User Guide*.

<note markdown=“1”> * This preference is only available for the Amazon EC2 instance and

Auto Scaling group resource types.

  • Compute Optimizer only supports the customization of ‘Ec2InstanceTypes`.

</note>

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/rightsizing-preferences.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#exclude_list ⇒ Array<String>

The preferred resource type values to exclude from the recommendation candidates. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.

Returns:

  • (Array<String>) 


5609
5610
5611
5612
5613
5614
5615
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5609

class PreferredResource < Struct.new(
  :name,
  :include_list,
  :exclude_list)
  SENSITIVE = []
  include Aws::Structure
end

#include_list ⇒ Array<String>

The preferred resource type values to include in the recommendation candidates. You can specify the exact resource type value, such as m5.large, or use wild card expressions, such as m5. If this isn’t specified, all supported resources are included by default. You can specify up to 1000 values in this list.

Returns:

  • (Array<String>) 


5609
5610
5611
5612
5613
5614
5615
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5609

class PreferredResource < Struct.new(
  :name,
  :include_list,
  :exclude_list)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The type of preferred resource to customize.

<note markdown=“1”> Compute Optimizer only supports the customization of ‘Ec2InstanceTypes`.

</note>

Returns:

  • (String) 


5609
5610
5611
5612
5613
5614
5615
 
# File 'lib/aws-sdk-computeoptimizer/types.rb', line 5609

class PreferredResource < Struct.new(
  :name,
  :include_list,
  :exclude_list)
  SENSITIVE = []
  include Aws::Structure
end