com.amazonaws.services.gamelift.model

Class ScalingPolicy

java.lang.Object

com.amazonaws.services.gamelift.model.ScalingPolicy

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ScalingPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScalingPolicy()

Method Summary

Modifier and Type	Method and Description
ScalingPolicy	clone()
boolean	equals(Object obj)
String	getComparisonOperator() Comparison operator to use when measuring a metric against the threshold value.
Integer	getEvaluationPeriods() Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
String	getFleetArn() The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
String	getFleetId() A unique identifier for the fleet that is associated with this scaling policy.
String	getLocation() The fleet location.
String	getMetricName() Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
String	getName() A descriptive label that is associated with a fleet's scaling policy.
String	getPolicyType() The type of scaling policy to create.
Integer	getScalingAdjustment() Amount of adjustment to make, based on the scaling adjustment type.
String	getScalingAdjustmentType() The type of adjustment to make to a fleet's instance count.
String	getStatus() Current status of the scaling policy.
TargetConfiguration	getTargetConfiguration() An object that contains settings for a target-based scaling policy.
Double	getThreshold() Metric value used to trigger a scaling event.
String	getUpdateStatus() The current status of the fleet's scaling policies in a requested fleet location.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setComparisonOperator(ComparisonOperatorType comparisonOperator) Comparison operator to use when measuring a metric against the threshold value.
void	setComparisonOperator(String comparisonOperator) Comparison operator to use when measuring a metric against the threshold value.
void	setEvaluationPeriods(Integer evaluationPeriods) Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
void	setFleetArn(String fleetArn) The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
void	setFleetId(String fleetId) A unique identifier for the fleet that is associated with this scaling policy.
void	setLocation(String location) The fleet location.
void	setMetricName(MetricName metricName) Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
void	setMetricName(String metricName) Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
void	setName(String name) A descriptive label that is associated with a fleet's scaling policy.
void	setPolicyType(PolicyType policyType) The type of scaling policy to create.
void	setPolicyType(String policyType) The type of scaling policy to create.
void	setScalingAdjustment(Integer scalingAdjustment) Amount of adjustment to make, based on the scaling adjustment type.
void	setScalingAdjustmentType(ScalingAdjustmentType scalingAdjustmentType) The type of adjustment to make to a fleet's instance count.
void	setScalingAdjustmentType(String scalingAdjustmentType) The type of adjustment to make to a fleet's instance count.
void	setStatus(ScalingStatusType status) Current status of the scaling policy.
void	setStatus(String status) Current status of the scaling policy.
void	setTargetConfiguration(TargetConfiguration targetConfiguration) An object that contains settings for a target-based scaling policy.
void	setThreshold(Double threshold) Metric value used to trigger a scaling event.
void	setUpdateStatus(LocationUpdateStatus updateStatus) The current status of the fleet's scaling policies in a requested fleet location.
void	setUpdateStatus(String updateStatus) The current status of the fleet's scaling policies in a requested fleet location.
String	toString() Returns a string representation of this object.
ScalingPolicy	withComparisonOperator(ComparisonOperatorType comparisonOperator) Comparison operator to use when measuring a metric against the threshold value.
ScalingPolicy	withComparisonOperator(String comparisonOperator) Comparison operator to use when measuring a metric against the threshold value.
ScalingPolicy	withEvaluationPeriods(Integer evaluationPeriods) Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
ScalingPolicy	withFleetArn(String fleetArn) The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it.
ScalingPolicy	withFleetId(String fleetId) A unique identifier for the fleet that is associated with this scaling policy.
ScalingPolicy	withLocation(String location) The fleet location.
ScalingPolicy	withMetricName(MetricName metricName) Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
ScalingPolicy	withMetricName(String metricName) Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment.
ScalingPolicy	withName(String name) A descriptive label that is associated with a fleet's scaling policy.
ScalingPolicy	withPolicyType(PolicyType policyType) The type of scaling policy to create.
ScalingPolicy	withPolicyType(String policyType) The type of scaling policy to create.
ScalingPolicy	withScalingAdjustment(Integer scalingAdjustment) Amount of adjustment to make, based on the scaling adjustment type.
ScalingPolicy	withScalingAdjustmentType(ScalingAdjustmentType scalingAdjustmentType) The type of adjustment to make to a fleet's instance count.
ScalingPolicy	withScalingAdjustmentType(String scalingAdjustmentType) The type of adjustment to make to a fleet's instance count.
ScalingPolicy	withStatus(ScalingStatusType status) Current status of the scaling policy.
ScalingPolicy	withStatus(String status) Current status of the scaling policy.
ScalingPolicy	withTargetConfiguration(TargetConfiguration targetConfiguration) An object that contains settings for a target-based scaling policy.
ScalingPolicy	withThreshold(Double threshold) Metric value used to trigger a scaling event.
ScalingPolicy	withUpdateStatus(LocationUpdateStatus updateStatus) The current status of the fleet's scaling policies in a requested fleet location.
ScalingPolicy	withUpdateStatus(String updateStatus) The current status of the fleet's scaling policies in a requested fleet location.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScalingPolicy

public ScalingPolicy()

Method Detail

setFleetId

public void setFleetId(String fleetId)

A unique identifier for the fleet that is associated with this scaling policy.

Parameters:

fleetId - A unique identifier for the fleet that is associated with this scaling policy.

getFleetId

public String getFleetId()

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.

withFleetId

public ScalingPolicy withFleetId(String fleetId)

A unique identifier for the fleet that is associated with this scaling policy.

Parameters:

fleetId - A unique identifier for the fleet that is associated with this scaling policy.

Returns:

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

setFleetArn

public void setFleetArn(String fleetArn)

The Amazon Resource Name (ARN) that is assigned to a Amazon 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 .

Parameters:

fleetArn - The Amazon Resource Name (ARN) that is assigned to a Amazon 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.

getFleetArn

public String getFleetArn()

The Amazon Resource Name (ARN) that is assigned to a Amazon 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 Amazon 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.

withFleetArn

public ScalingPolicy withFleetArn(String fleetArn)

The Amazon Resource Name (ARN) that is assigned to a Amazon 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 .

Parameters:

fleetArn - The Amazon Resource Name (ARN) that is assigned to a Amazon 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:

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

setName

public void setName(String name)

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

Parameters:

name - A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

getName

public String getName()

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.

withName

public ScalingPolicy withName(String name)

A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

Parameters:

name - A descriptive label that is associated with a fleet's scaling policy. Policy names do not need to be unique.

Returns:

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

setStatus

public void setStatus(String 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.

Parameters:

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.

See Also:

ScalingStatusType

getStatus

public String getStatus()

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.

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

withStatus

public ScalingPolicy withStatus(String 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.

Parameters:

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.

Returns:

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

See Also:

ScalingStatusType

setStatus

public void setStatus(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.

Parameters:

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.

See Also:

ScalingStatusType

withStatus

public ScalingPolicy withStatus(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.

Parameters:

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.

Returns:

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

See Also:

ScalingStatusType

setScalingAdjustment

public void setScalingAdjustment(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.

getScalingAdjustment

public Integer getScalingAdjustment()

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

Returns:

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

withScalingAdjustment

public ScalingPolicy withScalingAdjustment(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.

setScalingAdjustmentType

public void setScalingAdjustmentType(String 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.

Parameters:

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.

See Also:

ScalingAdjustmentType

getScalingAdjustmentType

public String getScalingAdjustmentType()

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.

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

withScalingAdjustmentType

public ScalingPolicy withScalingAdjustmentType(String 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.

Parameters:

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.

Returns:

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

See Also:

ScalingAdjustmentType

setScalingAdjustmentType

public void setScalingAdjustmentType(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.

Parameters:

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.

See Also:

ScalingAdjustmentType

withScalingAdjustmentType

public ScalingPolicy withScalingAdjustmentType(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.

Parameters:

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.

Returns:

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

See Also:

ScalingAdjustmentType

setComparisonOperator

public void setComparisonOperator(String comparisonOperator)

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

Parameters:

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

See Also:

ComparisonOperatorType

getComparisonOperator

public String getComparisonOperator()

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

Returns:

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

See Also:

ComparisonOperatorType

withComparisonOperator

public ScalingPolicy withComparisonOperator(String comparisonOperator)

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

Parameters:

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

Returns:

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

See Also:

ComparisonOperatorType

setComparisonOperator

public void setComparisonOperator(ComparisonOperatorType comparisonOperator)

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

Parameters:

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

See Also:

ComparisonOperatorType

withComparisonOperator

public ScalingPolicy withComparisonOperator(ComparisonOperatorType comparisonOperator)

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

Parameters:

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

Returns:

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

See Also:

ComparisonOperatorType

setThreshold

public void setThreshold(Double threshold)

Metric value used to trigger a scaling event.

Parameters:

threshold - Metric value used to trigger a scaling event.

getThreshold

public Double getThreshold()

Metric value used to trigger a scaling event.

Returns:

Metric value used to trigger a scaling event.

withThreshold

public ScalingPolicy withThreshold(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.

setEvaluationPeriods

public void setEvaluationPeriods(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.

getEvaluationPeriods

public Integer getEvaluationPeriods()

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.

withEvaluationPeriods

public ScalingPolicy withEvaluationPeriods(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.

setMetricName

public void setMetricName(String 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.

Parameters:

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.

See Also:

MetricName

getMetricName

public String getMetricName()

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.

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

withMetricName

public ScalingPolicy withMetricName(String 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.

Parameters:

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.

Returns:

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

See Also:

MetricName

setMetricName

public void setMetricName(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.

Parameters:

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.

See Also:

MetricName

withMetricName

public ScalingPolicy withMetricName(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.

Parameters:

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.

Returns:

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

See Also:

MetricName

setPolicyType

public void setPolicyType(String 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.

Parameters:

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.

See Also:

PolicyType

getPolicyType

public String getPolicyType()

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.

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

withPolicyType

public ScalingPolicy withPolicyType(String 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.

Parameters:

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.

Returns:

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

See Also:

PolicyType

setPolicyType

public void setPolicyType(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.

Parameters:

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.

See Also:

PolicyType

withPolicyType

public ScalingPolicy withPolicyType(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.

Parameters:

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.

Returns:

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

See Also:

PolicyType

setTargetConfiguration

public void setTargetConfiguration(TargetConfiguration targetConfiguration)

An object that contains settings for a target-based scaling policy.

Parameters:

targetConfiguration - An object that contains settings for a target-based scaling policy.

getTargetConfiguration

public TargetConfiguration getTargetConfiguration()

An object that contains settings for a target-based scaling policy.

Returns:

An object that contains settings for a target-based scaling policy.

withTargetConfiguration

public ScalingPolicy withTargetConfiguration(TargetConfiguration targetConfiguration)

An object that contains settings for a target-based scaling policy.

Parameters:

targetConfiguration - An object that contains settings for a target-based scaling policy.

Returns:

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

setUpdateStatus

public void setUpdateStatus(String 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.

Parameters:

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.

See Also:

LocationUpdateStatus

getUpdateStatus

public String getUpdateStatus()

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.

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

withUpdateStatus

public ScalingPolicy withUpdateStatus(String 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.

Parameters:

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.

Returns:

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

See Also:

LocationUpdateStatus

setUpdateStatus

public void setUpdateStatus(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.

Parameters:

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.

See Also:

LocationUpdateStatus

withUpdateStatus

public ScalingPolicy withUpdateStatus(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.

Parameters:

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.

Returns:

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

See Also:

LocationUpdateStatus

setLocation

public void setLocation(String location)

The fleet location.

Parameters:

location - The fleet location.

getLocation

public String getLocation()

The fleet location.

Returns:

The fleet location.

withLocation

public ScalingPolicy withLocation(String location)

The fleet location.

Parameters:

location - The fleet location.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ScalingPolicy clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.