Package software.amazon.awssdk.services.opsworks.model

Interface AutoScalingThresholds.Builder

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

  • Method Details

    • instanceCount

      AutoScalingThresholds.Builder instanceCount(Integer instanceCount)

      The number of instances to add or remove when the load exceeds a threshold.

      Parameters:
      instanceCount - The number of instances to add or remove when the load exceeds a threshold.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • thresholdsWaitTime

      AutoScalingThresholds.Builder thresholdsWaitTime(Integer thresholdsWaitTime)

      The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

      Parameters:
      thresholdsWaitTime - The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ignoreMetricsTime

      AutoScalingThresholds.Builder ignoreMetricsTime(Integer ignoreMetricsTime)

      The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

      Parameters:
      ignoreMetricsTime - The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cpuThreshold

      AutoScalingThresholds.Builder cpuThreshold(Double cpuThreshold)

      The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

      Parameters:
      cpuThreshold - The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memoryThreshold

      AutoScalingThresholds.Builder memoryThreshold(Double memoryThreshold)

      The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

      Parameters:
      memoryThreshold - The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loadThreshold

      AutoScalingThresholds.Builder loadThreshold(Double loadThreshold)

      The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

      Parameters:
      loadThreshold - The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarms

      AutoScalingThresholds.Builder alarms(Collection<String> alarms)

      Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

      To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

      Parameters:
      alarms - Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

      To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

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

    • alarms

      AutoScalingThresholds.Builder alarms(String... alarms)

      Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

      To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

      Parameters:
      alarms - Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

      To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

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