public static interface PutScalingPolicyRequest.Builder extends GameLiftRequest.Builder, CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>
Modifier and Type | Method and Description |
---|---|
PutScalingPolicyRequest.Builder |
comparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring the metric against the threshold value.
|
PutScalingPolicyRequest.Builder |
comparisonOperator(String comparisonOperator)
Comparison operator to use when measuring the metric against the threshold value.
|
PutScalingPolicyRequest.Builder |
evaluationPeriods(Integer evaluationPeriods)
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is
triggered.
|
PutScalingPolicyRequest.Builder |
fleetId(String fleetId)
Unique identifier for a fleet to apply this policy to.
|
PutScalingPolicyRequest.Builder |
metricName(MetricName metricName)
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
|
PutScalingPolicyRequest.Builder |
metricName(String metricName)
Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
|
PutScalingPolicyRequest.Builder |
name(String name)
Descriptive label that is associated with a scaling policy.
|
PutScalingPolicyRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
PutScalingPolicyRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
PutScalingPolicyRequest.Builder |
scalingAdjustment(Integer scalingAdjustment)
Amount of adjustment to make, based on the scaling adjustment type.
|
PutScalingPolicyRequest.Builder |
scalingAdjustmentType(ScalingAdjustmentType scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
|
PutScalingPolicyRequest.Builder |
scalingAdjustmentType(String scalingAdjustmentType)
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
|
PutScalingPolicyRequest.Builder |
threshold(Double threshold)
Metric value used to trigger a scaling event.
|
build
overrideConfiguration
copy
applyMutation, build
PutScalingPolicyRequest.Builder name(String name)
Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
name
- Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A
fleet can have only one scaling policy with the same name.PutScalingPolicyRequest.Builder fleetId(String fleetId)
Unique identifier for a fleet to apply this policy to.
fleetId
- Unique identifier for a fleet to apply this policy to.PutScalingPolicyRequest.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.PutScalingPolicyRequest.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; for example, a value of "-10" scales the fleet down by 10%.
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; for example, a value of "-10" scales the fleet down by 10%.
ScalingAdjustmentType
,
ScalingAdjustmentType
PutScalingPolicyRequest.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; for example, a value of "-10" scales the fleet down by 10%.
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; for example, a value of "-10" scales the fleet down by 10%.
ScalingAdjustmentType
,
ScalingAdjustmentType
PutScalingPolicyRequest.Builder threshold(Double threshold)
Metric value used to trigger a scaling event.
threshold
- Metric value used to trigger a scaling event.PutScalingPolicyRequest.Builder comparisonOperator(String comparisonOperator)
Comparison operator to use when measuring the metric against the threshold value.
comparisonOperator
- Comparison operator to use when measuring the metric against the threshold value.ComparisonOperatorType
,
ComparisonOperatorType
PutScalingPolicyRequest.Builder comparisonOperator(ComparisonOperatorType comparisonOperator)
Comparison operator to use when measuring the metric against the threshold value.
comparisonOperator
- Comparison operator to use when measuring the metric against the threshold value.ComparisonOperatorType
,
ComparisonOperatorType
PutScalingPolicyRequest.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.PutScalingPolicyRequest.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 includes 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 includes 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
PutScalingPolicyRequest.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 includes 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 includes 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
PutScalingPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.PutScalingPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.