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

Interface PutRecommendationPreferencesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ComputeOptimizerRequest.Builder, CopyableBuilder<PutRecommendationPreferencesRequest.Builder,PutRecommendationPreferencesRequest>, SdkBuilder<PutRecommendationPreferencesRequest.Builder,PutRecommendationPreferencesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutRecommendationPreferencesRequest
public static interface PutRecommendationPreferencesRequest.Builder extends ComputeOptimizerRequest.Builder, SdkPojo, CopyableBuilder<PutRecommendationPreferencesRequest.Builder,PutRecommendationPreferencesRequest>

  • Method Details

    • resourceType

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

      The valid values for this parameter are Ec2Instance and AutoScalingGroup.

      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.

      The valid values for this parameter are Ec2Instance and AutoScalingGroup.

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

    • resourceType

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

      The valid values for this parameter are Ec2Instance and AutoScalingGroup.

      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.

      The valid values for this parameter are Ec2Instance and AutoScalingGroup.

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

    • scope

      PutRecommendationPreferencesRequest.Builder scope(Scope 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.

      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.

      Parameters:
      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.

      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.

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

    • scope

      default PutRecommendationPreferencesRequest.Builder scope(Consumer<Scope.Builder> 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.

      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.

      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:

    • enhancedInfrastructureMetrics

      PutRecommendationPreferencesRequest.Builder enhancedInfrastructureMetrics(String enhancedInfrastructureMetrics)

      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.

      Parameters:
      enhancedInfrastructureMetrics - 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.

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

    • enhancedInfrastructureMetrics

      PutRecommendationPreferencesRequest.Builder enhancedInfrastructureMetrics(EnhancedInfrastructureMetrics enhancedInfrastructureMetrics)

      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.

      Parameters:
      enhancedInfrastructureMetrics - 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.

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

    • inferredWorkloadTypes

      PutRecommendationPreferencesRequest.Builder inferredWorkloadTypes(String inferredWorkloadTypes)

      The status of the inferred workload types recommendation preference to create or update.

      The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

      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.

      Parameters:
      inferredWorkloadTypes - The status of the inferred workload types recommendation preference to create or update.

      The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

      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.

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

    • inferredWorkloadTypes

      PutRecommendationPreferencesRequest.Builder inferredWorkloadTypes(InferredWorkloadTypesPreference inferredWorkloadTypes)

      The status of the inferred workload types recommendation preference to create or update.

      The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

      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.

      Parameters:
      inferredWorkloadTypes - The status of the inferred workload types recommendation preference to create or update.

      The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

      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.

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

    • externalMetricsPreference

      PutRecommendationPreferencesRequest.Builder externalMetricsPreference(ExternalMetricsPreference 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.

      Parameters:
      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.

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

    • externalMetricsPreference

      default PutRecommendationPreferencesRequest.Builder externalMetricsPreference(Consumer<ExternalMetricsPreference.Builder> 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.

      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:

    • lookBackPeriod

      PutRecommendationPreferencesRequest.Builder lookBackPeriod(String lookBackPeriod)

      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.

      Parameters:
      lookBackPeriod - 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.

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

    • lookBackPeriod

      PutRecommendationPreferencesRequest.Builder lookBackPeriod(LookBackPeriodPreference lookBackPeriod)

      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.

      Parameters:
      lookBackPeriod - 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.

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

    • utilizationPreferences

      PutRecommendationPreferencesRequest.Builder utilizationPreferences(Collection<UtilizationPreference> utilizationPreferences)

      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

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

      Parameters:
      utilizationPreferences - 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

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

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

    • utilizationPreferences

      PutRecommendationPreferencesRequest.Builder utilizationPreferences(UtilizationPreference... utilizationPreferences)

      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

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

      Parameters:
      utilizationPreferences - 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

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

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

    • utilizationPreferences

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

      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

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

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

      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:

    • preferredResources

      PutRecommendationPreferencesRequest.Builder preferredResources(Collection<PreferredResource> preferredResources)

      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.

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

      Parameters:
      preferredResources - 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.

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

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

    • preferredResources

      PutRecommendationPreferencesRequest.Builder preferredResources(PreferredResource... preferredResources)

      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.

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

      Parameters:
      preferredResources - 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.

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

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

    • preferredResources

      PutRecommendationPreferencesRequest.Builder preferredResources(Consumer<PreferredResource.Builder>... preferredResources)

      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.

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

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to preferredResources(List<PreferredResource>).

      Parameters:
      preferredResources - a consumer that will call methods on PreferredResource.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • savingsEstimationMode

      PutRecommendationPreferencesRequest.Builder savingsEstimationMode(String savingsEstimationMode)

      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.

      Parameters:
      savingsEstimationMode - 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.

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

    • savingsEstimationMode

      PutRecommendationPreferencesRequest.Builder savingsEstimationMode(SavingsEstimationMode savingsEstimationMode)

      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.

      Parameters:
      savingsEstimationMode - 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.

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

    • overrideConfiguration

      PutRecommendationPreferencesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutRecommendationPreferencesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.