Class PutScalingPolicyRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input for a request action.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Comparison operator to use when measuring the metric against the threshold value.Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.Unique identity for the fleet to scale with this policy.Name of the Service-defined metric that is used to trigger an adjustment.getName()
Descriptive label associated with this scaling policy.Amount of adjustment to make, based on the scaling adjustment type.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.Metric value used to trigger a scaling event.int
hashCode()
void
setComparisonOperator
(ComparisonOperatorType comparisonOperator) Comparison operator to use when measuring the metric against the threshold value.void
setComparisonOperator
(String comparisonOperator) Comparison operator to use when measuring the 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
setFleetId
(String fleetId) Unique identity for the fleet to scale with this policy.void
setMetricName
(MetricName metricName) Name of the Service-defined metric that is used to trigger an adjustment.void
setMetricName
(String metricName) Name of the Service-defined metric that is used to trigger an adjustment.void
Descriptive label associated with this scaling policy.void
setScalingAdjustment
(Integer scalingAdjustment) Amount of adjustment to make, based on the scaling adjustment type.void
setScalingAdjustmentType
(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.void
setScalingAdjustmentType
(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.void
setThreshold
(Double threshold) Metric value used to trigger a scaling event.toString()
Returns a string representation of this object; useful for testing and debugging.withComparisonOperator
(ComparisonOperatorType comparisonOperator) Comparison operator to use when measuring the metric against the threshold value.withComparisonOperator
(String comparisonOperator) Comparison operator to use when measuring the metric against the threshold value.withEvaluationPeriods
(Integer evaluationPeriods) Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.withFleetId
(String fleetId) Unique identity for the fleet to scale with this policy.withMetricName
(MetricName metricName) Name of the Service-defined metric that is used to trigger an adjustment.withMetricName
(String metricName) Name of the Service-defined metric that is used to trigger an adjustment.Descriptive label associated with this scaling policy.withScalingAdjustment
(Integer scalingAdjustment) Amount of adjustment to make, based on the scaling adjustment type.withScalingAdjustmentType
(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.withScalingAdjustmentType
(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.withThreshold
(Double threshold) Metric value used to trigger a scaling event.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
PutScalingPolicyRequest
public PutScalingPolicyRequest()
-
-
Method Details
-
setName
Descriptive label associated with this 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 associated with this scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
-
getName
Descriptive label associated with this scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
- Returns:
- Descriptive label associated with this scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
-
withName
Descriptive label associated with this 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 associated with this 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.
-
setFleetId
Unique identity for the fleet to scale with this policy.
- Parameters:
fleetId
- Unique identity for the fleet to scale with this policy.
-
getFleetId
Unique identity for the fleet to scale with this policy.
- Returns:
- Unique identity for the fleet to scale with this policy.
-
withFleetId
Unique identity for the fleet to scale with this policy.
- Parameters:
fleetId
- Unique identity for the fleet to scale with this policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setScalingAdjustment
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
Amount of adjustment to make, based on the scaling adjustment type.
- Returns:
- Amount of adjustment to make, based on the scaling adjustment type.
-
withScalingAdjustment
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
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%.
- See Also:
-
getScalingAdjustmentType
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:
- 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%.
- See Also:
-
withScalingAdjustmentType
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:
-
setScalingAdjustmentType
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%.
- See Also:
-
withScalingAdjustmentType
public PutScalingPolicyRequest withScalingAdjustmentType(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:
-
setThreshold
Metric value used to trigger a scaling event.
- Parameters:
threshold
- Metric value used to trigger a scaling event.
-
getThreshold
Metric value used to trigger a scaling event.
- Returns:
- Metric value used to trigger a scaling event.
-
withThreshold
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.
-
setComparisonOperator
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.- See Also:
-
getComparisonOperator
Comparison operator to use when measuring the metric against the threshold value.
- Returns:
- Comparison operator to use when measuring the metric against the threshold value.
- See Also:
-
withComparisonOperator
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:
-
setComparisonOperator
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.- See Also:
-
withComparisonOperator
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:
-
setEvaluationPeriods
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
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
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
Name of the Service-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 Service-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.
- See Also:
-
getMetricName
Name of the Service-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:
- Name of the Service-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.
- See Also:
-
withMetricName
Name of the Service-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 Service-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:
-
setMetricName
Name of the Service-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 Service-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.
- See Also:
-
withMetricName
Name of the Service-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 Service-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:
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-