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

Class PutRecommendationPreferencesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.computeoptimizer.model.ComputeOptimizerRequest
software.amazon.awssdk.services.computeoptimizer.model.PutRecommendationPreferencesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutRecommendationPreferencesRequest.Builder,PutRecommendationPreferencesRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutRecommendationPreferencesRequest extends ComputeOptimizerRequest implements ToCopyableBuilder<PutRecommendationPreferencesRequest.Builder,PutRecommendationPreferencesRequest>

  • Method Details

    • resourceType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

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

      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

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

      See Also:

    • scope

      public final 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.

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

    • enhancedInfrastructureMetrics

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, enhancedInfrastructureMetrics will return EnhancedInfrastructureMetrics.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enhancedInfrastructureMetricsAsString().

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

      See Also:

    • enhancedInfrastructureMetricsAsString

      public final String enhancedInfrastructureMetricsAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, enhancedInfrastructureMetrics will return EnhancedInfrastructureMetrics.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enhancedInfrastructureMetricsAsString().

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

      See Also:

    • inferredWorkloadTypes

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, inferredWorkloadTypes will return InferredWorkloadTypesPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inferredWorkloadTypesAsString().

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

      See Also:

    • inferredWorkloadTypesAsString

      public final String inferredWorkloadTypesAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, inferredWorkloadTypes will return InferredWorkloadTypesPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inferredWorkloadTypesAsString().

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

      See Also:

    • externalMetricsPreference

      public final 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.

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

    • lookBackPeriod

      public final 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.

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

      If the service returns an enum value that is not available in the current SDK version, lookBackPeriod will return LookBackPeriodPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookBackPeriodAsString().

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

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

      See Also:

    • lookBackPeriodAsString

      public final String lookBackPeriodAsString()

      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.

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

      If the service returns an enum value that is not available in the current SDK version, lookBackPeriod will return LookBackPeriodPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookBackPeriodAsString().

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

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

      See Also:

    • hasUtilizationPreferences

      public final boolean hasUtilizationPreferences()
      For responses, this returns true if the service returned a value for the UtilizationPreferences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • utilizationPreferences

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUtilizationPreferences() method.

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

    • hasPreferredResources

      public final boolean hasPreferredResources()
      For responses, this returns true if the service returned a value for the PreferredResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • preferredResources

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPreferredResources() method.

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

    • savingsEstimationMode

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, savingsEstimationMode will return SavingsEstimationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from savingsEstimationModeAsString().

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

      See Also:

    • savingsEstimationModeAsString

      public final String savingsEstimationModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, savingsEstimationMode will return SavingsEstimationMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from savingsEstimationModeAsString().

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

      See Also:

    • toBuilder

      public PutRecommendationPreferencesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutRecommendationPreferencesRequest.Builder,PutRecommendationPreferencesRequest>
      Specified by:
      toBuilder in class ComputeOptimizerRequest
      Returns:
      a builder for type T

    • builder

      public static PutRecommendationPreferencesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutRecommendationPreferencesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.