PreferredResource - Amazon Compute Optimizer
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

Note
  • This preference is only available for the Amazon EC2 instance and Auto Scaling group resource types.

  • Compute Optimizer only supports the customization of Ec2InstanceTypes.

Contents

excludeList

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.

Type: Array of strings

Required: No

includeList

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.

Type: Array of strings

Required: No

name

The type of preferred resource to customize.

Note

Compute Optimizer only supports the customization of Ec2InstanceTypes.

Type: String

Valid Values: Ec2InstanceTypes

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: