ScalingPolicy (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.gamelift.model.ScalingPolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ScalingPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
```
Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

Operations related to fleet capacity scaling include:
- DescribeFleetCapacity
- UpdateFleetCapacity
- DescribeEC2InstanceLimits
- Manage scaling policies:
  - PutScalingPolicy (auto-scaling)
  - DescribeScalingPolicies (auto-scaling)
  - DeleteScalingPolicy (auto-scaling)
- Manage fleet actions:
  - StartFleetActions
  - StopFleetActions
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ScalingPolicy.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ScalingPolicy.Builder`	`builder()`
`ComparisonOperatorType`	`comparisonOperator()` Comparison operator to use when measuring a metric against the threshold value.
`String`	`comparisonOperatorAsString()` Comparison operator to use when measuring a metric against the threshold value.
`boolean`	`equals(Object obj)`
`Integer`	`evaluationPeriods()` Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
`String`	`fleetId()` Unique identifier for a fleet that is associated with this scaling policy.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`MetricName`	`metricName()` Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
`String`	`metricNameAsString()` Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
`String`	`name()` Descriptive label that is associated with a scaling policy.
`PolicyType`	`policyType()` Type of scaling policy to create.
`String`	`policyTypeAsString()` Type of scaling policy to create.
`Integer`	`scalingAdjustment()` Amount of adjustment to make, based on the scaling adjustment type.
`ScalingAdjustmentType`	`scalingAdjustmentType()` Type of adjustment to make to a fleet's instance count (see FleetCapacity):
`String`	`scalingAdjustmentTypeAsString()` Type of adjustment to make to a fleet's instance count (see FleetCapacity):
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ScalingPolicy.Builder>`	`serializableBuilderClass()`
`ScalingStatusType`	`status()` Current status of the scaling policy.
`String`	`statusAsString()` Current status of the scaling policy.
`TargetConfiguration`	`targetConfiguration()` Object that contains settings for a target-based scaling policy.
`Double`	`threshold()` Metric value used to trigger a scaling event.
`ScalingPolicy.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
  - fleetId
```
public String fleetId()
```
    Unique identifier for a fleet that is associated with this scaling policy.
    
    Returns:
    
    Unique identifier for a fleet that is associated with this scaling policy.
  - name
```
public String name()
```
    Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
    
    Returns:
    
    Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
  - status
```
public ScalingStatusType status()
```
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
    - ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
    - UPDATE_REQUESTED -- A request to update the scaling policy has been received.
    - UPDATING -- A change is being made to the scaling policy.
    - DELETE_REQUESTED -- A request to delete the scaling policy has been received.
    - DELETING -- The scaling policy is being deleted.
    - DELETED -- The scaling policy has been deleted.
    - ERROR -- An error occurred in creating the policy. It should be removed and recreated.
    If the service returns an enum value that is not available in the current SDK version, status will return ScalingStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
    
    ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
    
    UPDATE_REQUESTED -- A request to update the scaling policy has been received.
    
    UPDATING -- A change is being made to the scaling policy.
    
    DELETE_REQUESTED -- A request to delete the scaling policy has been received.
    
    DELETING -- The scaling policy is being deleted.
    
    DELETED -- The scaling policy has been deleted.
    
    ERROR -- An error occurred in creating the policy. It should be removed and recreated.
    See Also:
    
    ScalingStatusType
  - statusAsString
```
public String statusAsString()
```
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
    - ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
    - UPDATE_REQUESTED -- A request to update the scaling policy has been received.
    - UPDATING -- A change is being made to the scaling policy.
    - DELETE_REQUESTED -- A request to delete the scaling policy has been received.
    - DELETING -- The scaling policy is being deleted.
    - DELETED -- The scaling policy has been deleted.
    - ERROR -- An error occurred in creating the policy. It should be removed and recreated.
    If the service returns an enum value that is not available in the current SDK version, status will return ScalingStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.
    
    ACTIVE -- The scaling policy can be used for auto-scaling a fleet.
    
    UPDATE_REQUESTED -- A request to update the scaling policy has been received.
    
    UPDATING -- A change is being made to the scaling policy.
    
    DELETE_REQUESTED -- A request to delete the scaling policy has been received.
    
    DELETING -- The scaling policy is being deleted.
    
    DELETED -- The scaling policy has been deleted.
    
    ERROR -- An error occurred in creating the policy. It should be removed and recreated.
    See Also:
    
    ScalingStatusType
  - scalingAdjustment
```
public Integer scalingAdjustment()
```
    Amount of adjustment to make, based on the scaling adjustment type.
    
    Returns:
    
    Amount of adjustment to make, based on the scaling adjustment type.
  - scalingAdjustmentType
```
public ScalingAdjustmentType scalingAdjustmentType()
```
    Type of adjustment to make to a fleet's instance count (see FleetCapacity):
    - ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
    - ExactCapacity -- set the instance count to the scaling adjustment value.
    - PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
    If the service returns an enum value that is not available in the current SDK version, scalingAdjustmentType will return ScalingAdjustmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingAdjustmentTypeAsString().
    Returns:
    Type of adjustment to make to a fleet's instance count (see FleetCapacity):
    
    ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
    
    ExactCapacity -- set the instance count to the scaling adjustment value.
    
    PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
    See Also:
    
    ScalingAdjustmentType
  - scalingAdjustmentTypeAsString
```
public String scalingAdjustmentTypeAsString()
```
    Type of adjustment to make to a fleet's instance count (see FleetCapacity):
    - ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
    - ExactCapacity -- set the instance count to the scaling adjustment value.
    - PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
    If the service returns an enum value that is not available in the current SDK version, scalingAdjustmentType will return ScalingAdjustmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from scalingAdjustmentTypeAsString().
    Returns:
    Type of adjustment to make to a fleet's instance count (see FleetCapacity):
    
    ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
    
    ExactCapacity -- set the instance count to the scaling adjustment value.
    
    PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
    See Also:
    
    ScalingAdjustmentType
  - comparisonOperator
```
public ComparisonOperatorType comparisonOperator()
```
    Comparison operator to use when measuring a metric against the threshold value.
    
    If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperatorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().
    
    Returns:
    
    Comparison operator to use when measuring a metric against the threshold value.
    
    See Also:
    
    ComparisonOperatorType
  - comparisonOperatorAsString
```
public String comparisonOperatorAsString()
```
    Comparison operator to use when measuring a metric against the threshold value.
    
    If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperatorType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().
    
    Returns:
    
    Comparison operator to use when measuring a metric against the threshold value.
    
    See Also:
    
    ComparisonOperatorType
  - threshold
```
public Double threshold()
```
    Metric value used to trigger a scaling event.
    
    Returns:
    
    Metric value used to trigger a scaling event.
  - evaluationPeriods
```
public Integer evaluationPeriods()
```
    Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
    
    Returns:
    
    Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
  - metricName
```
public MetricName metricName()
```
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.
    - ActivatingGameSessions -- Game sessions in the process of being created.
    - ActiveGameSessions -- Game sessions that are currently running.
    - ActiveInstances -- Fleet instances that are currently running at least one game session.
    - AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.
    - AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.
    - CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.
    - IdleInstances -- Active instances that are currently hosting zero game sessions.
    - PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
    - PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.
    - QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
    - WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
    If the service returns an enum value that is not available in the current SDK version, metricName will return MetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().
    Returns:
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.
    
    ActivatingGameSessions -- Game sessions in the process of being created.
    
    ActiveGameSessions -- Game sessions that are currently running.
    
    ActiveInstances -- Fleet instances that are currently running at least one game session.
    
    AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.
    
    AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.
    
    CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.
    
    IdleInstances -- Active instances that are currently hosting zero game sessions.
    
    PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
    
    PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.
    
    QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
    
    WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
    See Also:
    
    MetricName
  - metricNameAsString
```
public String metricNameAsString()
```
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.
    - ActivatingGameSessions -- Game sessions in the process of being created.
    - ActiveGameSessions -- Game sessions that are currently running.
    - ActiveInstances -- Fleet instances that are currently running at least one game session.
    - AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.
    - AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.
    - CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.
    - IdleInstances -- Active instances that are currently hosting zero game sessions.
    - PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
    - PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.
    - QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
    - WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
    If the service returns an enum value that is not available in the current SDK version, metricName will return MetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().
    Returns:
    Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.
    
    ActivatingGameSessions -- Game sessions in the process of being created.
    
    ActiveGameSessions -- Game sessions that are currently running.
    
    ActiveInstances -- Fleet instances that are currently running at least one game session.
    
    AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.
    
    AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.
    
    CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.
    
    IdleInstances -- Active instances that are currently hosting zero game sessions.
    
    PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.
    
    PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.
    
    QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
    
    WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.
    See Also:
    
    MetricName
  - policyType
```
public PolicyType policyType()
```
    Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    
    If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().
    
    Returns:
    
    Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    
    See Also:
    
    PolicyType
  - policyTypeAsString
```
public String policyTypeAsString()
```
    Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    
    If the service returns an enum value that is not available in the current SDK version, policyType will return PolicyType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from policyTypeAsString().
    
    Returns:
    
    Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.
    
    See Also:
    
    PolicyType
  - targetConfiguration
```
public TargetConfiguration targetConfiguration()
```
    Object that contains settings for a target-based scaling policy.
    
    Returns:
    
    Object that contains settings for a target-based scaling policy.
  - toBuilder
```
public ScalingPolicy.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<ScalingPolicy.Builder,ScalingPolicy>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ScalingPolicy.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScalingPolicy.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 ScalingPolicy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

fleetId

name

status

statusAsString

scalingAdjustment

scalingAdjustmentType

scalingAdjustmentTypeAsString

comparisonOperator

comparisonOperatorAsString

threshold

evaluationPeriods

metricName

metricNameAsString

policyType

policyTypeAsString

targetConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields