software.amazon.awssdk.services.gamelift.model

Interface PutScalingPolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>, GameLiftRequest.Builder, SdkBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>, SdkRequest.Builder

Enclosing class:

PutScalingPolicyRequest

public static interface PutScalingPolicyRequest.Builder
extends GameLiftRequest.Builder, CopyableBuilder<PutScalingPolicyRequest.Builder,PutScalingPolicyRequest>

Method Summary

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	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
PutScalingPolicyRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.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.

Methods inherited from interface software.amazon.awssdk.services.gamelift.model.GameLiftRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

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

copy

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

apply, build

Method Detail

name

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

fleetId

PutScalingPolicyRequest.Builder fleetId(String fleetId)

Unique identifier for a fleet to apply this policy to.

Parameters:

fleetId - Unique identifier for a fleet to apply this policy to.

Returns:

Returns a reference to this object so that method calls can be chained together.

scalingAdjustment

PutScalingPolicyRequest.Builder scalingAdjustment(Integer scalingAdjustment)

Amount of adjustment to make, based on the scaling adjustment type.

Parameters:

scalingAdjustment - Amount of adjustment to make, based on the scaling adjustment type.

Returns:

Returns a reference to this object so that method calls can be chained together.

scalingAdjustmentType

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%.

Parameters:

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%.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingAdjustmentType, 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%.

Parameters:

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%.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScalingAdjustmentType, ScalingAdjustmentType

threshold

PutScalingPolicyRequest.Builder threshold(Double threshold)

Metric value used to trigger a scaling event.

Parameters:

threshold - Metric value used to trigger a scaling event.

Returns:

Returns a reference to this object so that method calls can be chained together.

comparisonOperator

PutScalingPolicyRequest.Builder comparisonOperator(String comparisonOperator)

Comparison operator to use when measuring the metric against the threshold value.

Parameters:

comparisonOperator - Comparison operator to use when measuring the metric against the threshold value.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComparisonOperatorType, ComparisonOperatorType

comparisonOperator

PutScalingPolicyRequest.Builder comparisonOperator(ComparisonOperatorType comparisonOperator)

Comparison operator to use when measuring the metric against the threshold value.

Parameters:

comparisonOperator - Comparison operator to use when measuring the metric against the threshold value.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComparisonOperatorType, ComparisonOperatorType

evaluationPeriods

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.

Parameters:

evaluationPeriods - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricName

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetricName, 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetricName, MetricName

requestOverrideConfig

PutScalingPolicyRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

PutScalingPolicyRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.