public static interface ScalingPolicy.Builder extends CopyableBuilder<ScalingPolicy.Builder,ScalingPolicy>
Modifier and Type | Method and Description |
---|---|
ScalingPolicy.Builder |
comparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
|
ScalingPolicy.Builder |
comparisonOperator(String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
|
ScalingPolicy.Builder |
evaluationPeriods(Integer evaluationPeriods)
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is
triggered.
|
ScalingPolicy.Builder |
fleetId(String fleetId)
Unique identifier for a fleet that is associated with this scaling policy.
|
ScalingPolicy.Builder |
metricName(MetricName metricName)
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
|
ScalingPolicy.Builder |
metricName(String metricName)
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
|
ScalingPolicy.Builder |
name(String name)
Descriptive label that is associated with a scaling policy.
|
ScalingPolicy.Builder |
scalingAdjustment(Integer scalingAdjustment)
Amount of adjustment to make, based on the scaling adjustment type.
|
ScalingPolicy.Builder |
scalingAdjustmentType(ScalingAdjustmentType scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
|
ScalingPolicy.Builder |
scalingAdjustmentType(String scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
|
ScalingPolicy.Builder |
status(ScalingStatusType status)
Current status of the scaling policy.
|
ScalingPolicy.Builder |
status(String status)
Current status of the scaling policy.
|
ScalingPolicy.Builder |
threshold(Double threshold)
Metric value used to trigger a scaling event.
|
copy
apply, build
ScalingPolicy.Builder fleetId(String fleetId)
Unique identifier for a fleet that is associated with this scaling policy.
fleetId
- Unique identifier for a fleet that is associated with this scaling policy.ScalingPolicy.Builder name(String name)
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.
name
- Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.ScalingPolicy.Builder status(String status)
Current status of the scaling policy. The scaling policy is only in force when in an ACTIVE
status.
ACTIVE -- The scaling policy is currently in force.
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.
status
- Current status of the scaling policy. The scaling policy is only in force when in an
ACTIVE
status.
ACTIVE -- The scaling policy is currently in force.
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.
ScalingStatusType
,
ScalingStatusType
ScalingPolicy.Builder status(ScalingStatusType status)
Current status of the scaling policy. The scaling policy is only in force when in an ACTIVE
status.
ACTIVE -- The scaling policy is currently in force.
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.
status
- Current status of the scaling policy. The scaling policy is only in force when in an
ACTIVE
status.
ACTIVE -- The scaling policy is currently in force.
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.
ScalingStatusType
,
ScalingStatusType
ScalingPolicy.Builder scalingAdjustment(Integer scalingAdjustment)
Amount of adjustment to make, based on the scaling adjustment type.
scalingAdjustment
- Amount of adjustment to make, based on the scaling adjustment type.ScalingPolicy.Builder scalingAdjustmentType(String 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.
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.
ScalingAdjustmentType
,
ScalingAdjustmentType
ScalingPolicy.Builder scalingAdjustmentType(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.
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.
ScalingAdjustmentType
,
ScalingAdjustmentType
ScalingPolicy.Builder comparisonOperator(String comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
comparisonOperator
- Comparison operator to use when measuring a metric against the threshold value.ComparisonOperatorType
,
ComparisonOperatorType
ScalingPolicy.Builder comparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring a metric against the threshold value.
comparisonOperator
- Comparison operator to use when measuring a metric against the threshold value.ComparisonOperatorType
,
ComparisonOperatorType
ScalingPolicy.Builder threshold(Double threshold)
Metric value used to trigger a scaling event.
threshold
- Metric value used to trigger a scaling event.ScalingPolicy.Builder evaluationPeriods(Integer evaluationPeriods)
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
evaluationPeriods
- Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is
triggered.ScalingPolicy.Builder metricName(String metricName)
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ActivatingGameSessions -- number of game sessions in the process of being created (game session status
= ACTIVATING
).
ActiveGameSessions -- number of game sessions currently running (game session status =
ACTIVE
).
CurrentPlayerSessions -- number of active or reserved player sessions (player session status =
ACTIVE
or RESERVED
).
AvailablePlayerSessions -- number of player session slots currently available in active game sessions
across the fleet, calculated by subtracting a game session's current player session count from its maximum
player session count. This number does include game sessions that are not currently accepting players (game
session PlayerSessionCreationPolicy
= DENY_ALL
).
ActiveInstances -- number of instances currently running a game session.
IdleInstances -- number of instances not currently running a game session.
metricName
- Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ActivatingGameSessions -- number of game sessions in the process of being created (game session
status = ACTIVATING
).
ActiveGameSessions -- number of game sessions currently running (game session status =
ACTIVE
).
CurrentPlayerSessions -- number of active or reserved player sessions (player session status =
ACTIVE
or RESERVED
).
AvailablePlayerSessions -- number of player session slots currently available in active game
sessions across the fleet, calculated by subtracting a game session's current player session count
from its maximum player session count. This number does include game sessions that are not currently
accepting players (game session PlayerSessionCreationPolicy
= DENY_ALL
).
ActiveInstances -- number of instances currently running a game session.
IdleInstances -- number of instances not currently running a game session.
MetricName
,
MetricName
ScalingPolicy.Builder metricName(MetricName metricName)
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ActivatingGameSessions -- number of game sessions in the process of being created (game session status
= ACTIVATING
).
ActiveGameSessions -- number of game sessions currently running (game session status =
ACTIVE
).
CurrentPlayerSessions -- number of active or reserved player sessions (player session status =
ACTIVE
or RESERVED
).
AvailablePlayerSessions -- number of player session slots currently available in active game sessions
across the fleet, calculated by subtracting a game session's current player session count from its maximum
player session count. This number does include game sessions that are not currently accepting players (game
session PlayerSessionCreationPolicy
= DENY_ALL
).
ActiveInstances -- number of instances currently running a game session.
IdleInstances -- number of instances not currently running a game session.
metricName
- Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ActivatingGameSessions -- number of game sessions in the process of being created (game session
status = ACTIVATING
).
ActiveGameSessions -- number of game sessions currently running (game session status =
ACTIVE
).
CurrentPlayerSessions -- number of active or reserved player sessions (player session status =
ACTIVE
or RESERVED
).
AvailablePlayerSessions -- number of player session slots currently available in active game
sessions across the fleet, calculated by subtracting a game session's current player session count
from its maximum player session count. This number does include game sessions that are not currently
accepting players (game session PlayerSessionCreationPolicy
= DENY_ALL
).
ActiveInstances -- number of instances currently running a game session.
IdleInstances -- number of instances not currently running a game session.
MetricName
,
MetricName
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.