Package software.amazon.awscdk.services.gamelift

Class CfnFleet.ScalingPolicyProperty.Builder

java.lang.Object
software.amazon.awscdk.services.gamelift.CfnFleet.ScalingPolicyProperty.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFleet.ScalingPolicyProperty>
Enclosing interface:
CfnFleet.ScalingPolicyProperty
@Stability(Stable) public static final class CfnFleet.ScalingPolicyProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnFleet.ScalingPolicyProperty>
A builder for CfnFleet.ScalingPolicyProperty

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • metricName

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder metricName(String metricName)
      Sets the value of CfnFleet.ScalingPolicyProperty.getMetricName()
      Parameters:
      metricName - Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. This parameter is required. 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:
      this

    • name

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder name(String name)
      Sets the value of CfnFleet.ScalingPolicyProperty.getName()
      Parameters:
      name - A descriptive label that is associated with a fleet's scaling policy. This parameter is required. Policy names do not need to be unique.
      Returns:
      this

    • comparisonOperator

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder comparisonOperator(String comparisonOperator)
      Sets the value of CfnFleet.ScalingPolicyProperty.getComparisonOperator()
      Parameters:
      comparisonOperator - Comparison operator to use when measuring a metric against the threshold value.
      Returns:
      this

    • evaluationPeriods

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder evaluationPeriods(Number evaluationPeriods)
      Sets the value of CfnFleet.ScalingPolicyProperty.getEvaluationPeriods()
      Parameters:
      evaluationPeriods - Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
      Returns:
      this

    • location

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder location(String location)
      Sets the value of CfnFleet.ScalingPolicyProperty.getLocation()
      Parameters:
      location - The fleet location.
      Returns:
      this

    • policyType

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder policyType(String policyType)
      Sets the value of CfnFleet.ScalingPolicyProperty.getPolicyType()
      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:
      this

    • scalingAdjustment

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder scalingAdjustment(Number scalingAdjustment)
      Sets the value of CfnFleet.ScalingPolicyProperty.getScalingAdjustment()
      Parameters:
      scalingAdjustment - Amount of adjustment to make, based on the scaling adjustment type.
      Returns:
      this

    • scalingAdjustmentType

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder scalingAdjustmentType(String scalingAdjustmentType)
      Sets the value of CfnFleet.ScalingPolicyProperty.getScalingAdjustmentType()
      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:
      this

    • status

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder status(String status)
      Sets the value of CfnFleet.ScalingPolicyProperty.getStatus()
      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:
      this

    • targetConfiguration

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder targetConfiguration(IResolvable targetConfiguration)
      Sets the value of CfnFleet.ScalingPolicyProperty.getTargetConfiguration()
      Parameters:
      targetConfiguration - An object that contains settings for a target-based scaling policy.
      Returns:
      this

    • targetConfiguration

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder targetConfiguration(CfnFleet.TargetConfigurationProperty targetConfiguration)
      Sets the value of CfnFleet.ScalingPolicyProperty.getTargetConfiguration()
      Parameters:
      targetConfiguration - An object that contains settings for a target-based scaling policy.
      Returns:
      this

    • threshold

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder threshold(Number threshold)
      Sets the value of CfnFleet.ScalingPolicyProperty.getThreshold()
      Parameters:
      threshold - Metric value used to trigger a scaling event.
      Returns:
      this

    • updateStatus

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty.Builder updateStatus(String updateStatus)
      Sets the value of CfnFleet.ScalingPolicyProperty.getUpdateStatus()
      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:
      this

    • build

      @Stability(Stable) public CfnFleet.ScalingPolicyProperty build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnFleet.ScalingPolicyProperty>
      Returns:
      a new instance of CfnFleet.ScalingPolicyProperty
      Throws:
      NullPointerException - if any required attribute was not provided