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

Interface ScalingInstruction.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ScalingInstruction.Builder,ScalingInstruction>, SdkBuilder<ScalingInstruction.Builder,ScalingInstruction>, SdkPojo
Enclosing class:
ScalingInstruction
public static interface ScalingInstruction.Builder extends SdkPojo, CopyableBuilder<ScalingInstruction.Builder,ScalingInstruction>

  • Method Details

    • serviceNamespace

      ScalingInstruction.Builder serviceNamespace(String serviceNamespace)

      The namespace of the AWS service.

      Parameters:
      serviceNamespace - The namespace of the AWS service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serviceNamespace

      ScalingInstruction.Builder serviceNamespace(ServiceNamespace serviceNamespace)

      The namespace of the AWS service.

      Parameters:
      serviceNamespace - The namespace of the AWS service.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • resourceId

      ScalingInstruction.Builder resourceId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • scalableDimension

      ScalingInstruction.Builder scalableDimension(String 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.

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

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

    • scalableDimension

      ScalingInstruction.Builder scalableDimension(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.

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

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

    • minCapacity

      ScalingInstruction.Builder minCapacity(Integer minCapacity)

      The minimum capacity of the resource.

      Parameters:
      minCapacity - The minimum capacity of the resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxCapacity

      ScalingInstruction.Builder maxCapacity(Integer maxCapacity)

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

      Parameters:
      maxCapacity - The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetTrackingConfigurations

      ScalingInstruction.Builder targetTrackingConfigurations(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetTrackingConfigurations

      ScalingInstruction.Builder targetTrackingConfigurations(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • targetTrackingConfigurations

      ScalingInstruction.Builder targetTrackingConfigurations(Consumer<TargetTrackingConfiguration.Builder>... 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.

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

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

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

    • predefinedLoadMetricSpecification

      ScalingInstruction.Builder predefinedLoadMetricSpecification(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • predefinedLoadMetricSpecification

      default ScalingInstruction.Builder predefinedLoadMetricSpecification(Consumer<PredefinedLoadMetricSpecification.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to predefinedLoadMetricSpecification(PredefinedLoadMetricSpecification).

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

    • customizedLoadMetricSpecification

      ScalingInstruction.Builder customizedLoadMetricSpecification(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • customizedLoadMetricSpecification

      default ScalingInstruction.Builder customizedLoadMetricSpecification(Consumer<CustomizedLoadMetricSpecification.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customizedLoadMetricSpecification(CustomizedLoadMetricSpecification).

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

    • scheduledActionBufferTime

      ScalingInstruction.Builder scheduledActionBufferTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • predictiveScalingMaxCapacityBehavior

      ScalingInstruction.Builder predictiveScalingMaxCapacityBehavior(String 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.

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

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

    • predictiveScalingMaxCapacityBehavior

      ScalingInstruction.Builder predictiveScalingMaxCapacityBehavior(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.

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

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

    • predictiveScalingMaxCapacityBuffer

      ScalingInstruction.Builder predictiveScalingMaxCapacityBuffer(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • predictiveScalingMode

      ScalingInstruction.Builder predictiveScalingMode(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • predictiveScalingMode

      ScalingInstruction.Builder predictiveScalingMode(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • scalingPolicyUpdateBehavior

      ScalingInstruction.Builder scalingPolicyUpdateBehavior(String 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.

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

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

    • scalingPolicyUpdateBehavior

      ScalingInstruction.Builder scalingPolicyUpdateBehavior(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.

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

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

    • disableDynamicScaling

      ScalingInstruction.Builder disableDynamicScaling(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.