AutoScalingThresholds (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.opsworks.model.AutoScalingThresholds

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutoScalingThresholds.Builder,AutoScalingThresholds>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class AutoScalingThresholds
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutoScalingThresholds.Builder,AutoScalingThresholds>
```
Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AutoScalingThresholds.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AutoScalingThresholds.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`alarms()` Custom Cloudwatch auto scaling alarms, to be used as thresholds.
`static AutoScalingThresholds.Builder`	`builder()`
`Double`	`cpuThreshold()` The CPU utilization threshold, as a percent of the available CPU.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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.
`Integer`	`instanceCount()` The number of instances to add or remove when the load exceeds a threshold.
`Double`	`loadThreshold()` The load threshold.
`Double`	`memoryThreshold()` The memory utilization threshold, as a percent of the available memory.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutoScalingThresholds.Builder>`	`serializableBuilderClass()`
`Integer`	`thresholdsWaitTime()` The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
`AutoScalingThresholds.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - instanceCount
```
public Integer instanceCount()
```
    The number of instances to add or remove when the load exceeds a threshold.
    
    Returns:
    
    The number of instances to add or remove when the load exceeds a threshold.
  - thresholdsWaitTime
```
public Integer thresholdsWaitTime()
```
    The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
    
    Returns:
    
    The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
  - ignoreMetricsTime
```
public 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.
    
    Returns:
    
    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.
  - cpuThreshold
```
public Double cpuThreshold()
```
    The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
    
    Returns:
    
    The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
  - memoryThreshold
```
public Double memoryThreshold()
```
    The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
    
    Returns:
    
    The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
  - loadThreshold
```
public Double loadThreshold()
```
    The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
    
    Returns:
    
    The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).
  - alarms
```
public List<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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    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.
  - toBuilder
```
public AutoScalingThresholds.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<AutoScalingThresholds.Builder,AutoScalingThresholds>
    
    Returns:
    
    a builder for type T
  - builder
```
public static AutoScalingThresholds.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AutoScalingThresholds.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public 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.

Class AutoScalingThresholds

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

instanceCount

thresholdsWaitTime

ignoreMetricsTime

cpuThreshold

memoryThreshold

loadThreshold

alarms

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields