ScalingPolicy (AWS Java SDK :: Services :: AWS GameLift 2.18.35 API)

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.

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)`
`boolean`	`equalsBySdkFields(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`	`fleetArn()` The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it.
`String`	`fleetId()` A unique identifier for the fleet that is associated with this scaling policy.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`location()` The fleet location.
`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()` A descriptive label that is associated with a fleet's scaling policy.
`PolicyType`	`policyType()` The type of scaling policy to create.
`String`	`policyTypeAsString()` The type of scaling policy to create.
`Integer`	`scalingAdjustment()` Amount of adjustment to make, based on the scaling adjustment type.
`ScalingAdjustmentType`	`scalingAdjustmentType()` The type of adjustment to make to a fleet's instance count.
`String`	`scalingAdjustmentTypeAsString()` The type of adjustment to make to a fleet's instance count.
`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()` An object that contains settings for a target-based scaling policy.
`Double`	`threshold()` Metric value used to trigger a scaling event.
`ScalingPolicy.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`LocationUpdateStatus`	`updateStatus()` The current status of the fleet's scaling policies in a requested fleet location.
`String`	`updateStatusAsString()` The current status of the fleet's scaling policies in a requested fleet location.

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

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

- Method Detail
  - fleetId
```
public final String fleetId()
```
    A unique identifier for the fleet that is associated with this scaling policy.
    
    Returns:
    
    A unique identifier for the fleet that is associated with this scaling policy.
  - fleetArn
```
public final String fleetArn()
```
    The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
    
    Returns:
    
    The Amazon Resource Name (ARN) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.
  - name
```
public final String name()
```
    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
    
    Returns:
    
    A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.
  - status
```
public final 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. If the policy is suspended for a fleet, the policy status does not change.
    - 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. If the policy is suspended for a fleet, the policy status does not change.
    
    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 final 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. If the policy is suspended for a fleet, the policy status does not change.
    - 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. If the policy is suspended for a fleet, the policy status does not change.
    
    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 final 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 final ScalingAdjustmentType scalingAdjustmentType()
```
    The type of adjustment to make to a fleet's instance count.
    - 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:
    The type of adjustment to make to a fleet's instance count.
    
    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 final String scalingAdjustmentTypeAsString()
```
    The type of adjustment to make to a fleet's instance count.
    - 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:
    The type of adjustment to make to a fleet's instance count.
    
    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 final 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 final 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 final Double threshold()
```
    Metric value used to trigger a scaling event.
    
    Returns:
    
    Metric value used to trigger a scaling event.
  - evaluationPeriods
```
public final 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 final 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 final 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 final PolicyType policyType()
```
    The 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:
    
    The 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 final String policyTypeAsString()
```
    The 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:
    
    The 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 final TargetConfiguration targetConfiguration()
```
    An object that contains settings for a target-based scaling policy.
    
    Returns:
    
    An object that contains settings for a target-based scaling policy.
  - updateStatus
```
public final LocationUpdateStatus updateStatus()
```
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    
    If the service returns an enum value that is not available in the current SDK version, updateStatus will return LocationUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateStatusAsString().
    
    Returns:
    
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    
    See Also:
    
    LocationUpdateStatus
  - updateStatusAsString
```
public final String updateStatusAsString()
```
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    
    If the service returns an enum value that is not available in the current SDK version, updateStatus will return LocationUpdateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from updateStatusAsString().
    
    Returns:
    
    The current status of the fleet's scaling policies in a requested fleet location. The status PENDING_UPDATE indicates that an update was requested for the fleet but has not yet been completed for the location.
    
    See Also:
    
    LocationUpdateStatus
  - location
```
public final String location()
```
    The fleet location.
    
    Returns:
    
    The fleet location.
  - toBuilder
```
public ScalingPolicy.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
  - builder
```
public static ScalingPolicy.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ScalingPolicy.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

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

fleetArn

name

status

statusAsString

scalingAdjustment

scalingAdjustmentType

scalingAdjustmentTypeAsString

comparisonOperator

comparisonOperatorAsString

threshold

evaluationPeriods

metricName

metricNameAsString

policyType

policyTypeAsString

targetConfiguration

updateStatus

updateStatusAsString

location

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields