Package software.amazon.awssdk.services.autoscalingplans.model

Class ScalingInstruction

java.lang.Object
software.amazon.awssdk.services.autoscalingplans.model.ScalingInstruction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ScalingInstruction.Builder,ScalingInstruction>
@Generated("software.amazon.awssdk:codegen") public final class ScalingInstruction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ScalingInstruction.Builder,ScalingInstruction>

Describes a scaling instruction for a scalable resource in a scaling plan. Each scaling instruction applies to one resource.

AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.

AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.

We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast. For more information, see Best Practices for AWS Auto Scaling in the AWS Auto Scaling User Guide.

See Also:

  • Method Details

    • serviceNamespace

      public final ServiceNamespace serviceNamespace()

      The namespace of the AWS service.

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

      Returns:
      The namespace of the AWS service.
      See Also:

    • serviceNamespaceAsString

      public final String serviceNamespaceAsString()

      The namespace of the AWS service.

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

      Returns:
      The namespace of the AWS service.
      See Also:

    • resourceId

      public final String resourceId()

      The ID of the resource. This string consists of the resource type and unique identifier.

      • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

      Returns:
      The ID of the resource. This string consists of the resource type and unique identifier.

      • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

      • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

      • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

    • scalableDimension

      public final ScalableDimension scalableDimension()

      The scalable dimension associated with the resource.

      • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

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

      Returns:
      The scalable dimension associated with the resource.

      • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      See Also:

    • scalableDimensionAsString

      public final String scalableDimensionAsString()

      The scalable dimension associated with the resource.

      • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

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

      Returns:
      The scalable dimension associated with the resource.

      • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

      • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

      • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

      • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

      • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

      • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

      See Also:

    • minCapacity

      public final Integer minCapacity()

      The minimum capacity of the resource.

      Returns:
      The minimum capacity of the resource.

    • maxCapacity

      public final Integer maxCapacity()

      The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

      Returns:
      The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

    • hasTargetTrackingConfigurations

      public final boolean hasTargetTrackingConfigurations()
      For responses, this returns true if the service returned a value for the TargetTrackingConfigurations 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.

    • targetTrackingConfigurations

      public final List<TargetTrackingConfiguration> targetTrackingConfigurations()

      The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.

      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 hasTargetTrackingConfigurations() method.

      Returns:
      The target tracking configurations (up to 10). Each of these structures must specify a unique scaling metric and a target value for the metric.

    • predefinedLoadMetricSpecification

      public final PredefinedLoadMetricSpecification predefinedLoadMetricSpecification()

      The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

      Returns:
      The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

    • customizedLoadMetricSpecification

      public final CustomizedLoadMetricSpecification customizedLoadMetricSpecification()

      The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

      Returns:
      The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

    • scheduledActionBufferTime

      public final Integer scheduledActionBufferTime()

      The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

      The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

      Only valid when configuring predictive scaling.

      Returns:
      The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

      The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

      Only valid when configuring predictive scaling.

    • predictiveScalingMaxCapacityBehavior

      public final PredictiveScalingMaxCapacityBehavior predictiveScalingMaxCapacityBehavior()

      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.

      The following are possible values:

      • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

      • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

      • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

      Only valid when configuring predictive scaling.

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

      Returns:
      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity .

      The following are possible values:

      • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

      • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

      • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

      Only valid when configuring predictive scaling.

      See Also:

    • predictiveScalingMaxCapacityBehaviorAsString

      public final String predictiveScalingMaxCapacityBehaviorAsString()

      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.

      The following are possible values:

      • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

      • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

      • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

      Only valid when configuring predictive scaling.

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

      Returns:
      Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity .

      The following are possible values:

      • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

      • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

      • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

      Only valid when configuring predictive scaling.

      See Also:

    • predictiveScalingMaxCapacityBuffer

      public final Integer predictiveScalingMaxCapacityBuffer()

      The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

      Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

      The range is 1-100.

      Returns:
      The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

      Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

      The range is 1-100.

    • predictiveScalingMode

      public final PredictiveScalingMode predictiveScalingMode()

      The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.

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

      Returns:
      The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
      See Also:

    • predictiveScalingModeAsString

      public final String predictiveScalingModeAsString()

      The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.

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

      Returns:
      The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.
      See Also:

    • scalingPolicyUpdateBehavior

      public final ScalingPolicyUpdateBehavior scalingPolicyUpdateBehavior()

      Controls whether a resource's externally created scaling policies are kept or replaced.

      The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

      Only valid when configuring dynamic scaling.

      Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

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

      Returns:
      Controls whether a resource's externally created scaling policies are kept or replaced.

      The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

      Only valid when configuring dynamic scaling.

      Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

      See Also:

    • scalingPolicyUpdateBehaviorAsString

      public final String scalingPolicyUpdateBehaviorAsString()

      Controls whether a resource's externally created scaling policies are kept or replaced.

      The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

      Only valid when configuring dynamic scaling.

      Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

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

      Returns:
      Controls whether a resource's externally created scaling policies are kept or replaced.

      The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

      Only valid when configuring dynamic scaling.

      Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

      See Also:

    • disableDynamicScaling

      public final Boolean disableDynamicScaling()

      Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

      The default is enabled (false).

      Returns:
      Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

      The default is enabled (false).

    • toBuilder

      public ScalingInstruction.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<ScalingInstruction.Builder,ScalingInstruction>
      Returns:
      a builder for type T

    • builder

      public static ScalingInstruction.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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