Class: AWSCDK::GameLift::CfnFleet::TargetConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::GameLift::CfnFleet::TargetConfigurationProperty

Defined in:

game_lift/cfn_fleet.rb

Overview

Settings for a target-based scaling policy.

A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift Servers to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html

Instance Attribute Summary

• #target_value ⇒ Numeric readonly

  Desired value to use with a target-based scaling policy.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(target_value:) ⇒ TargetConfigurationProperty constructor

  A new instance of TargetConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(target_value:) ⇒ TargetConfigurationProperty

Returns a new instance of TargetConfigurationProperty.

Parameters:

• target_value (Numeric) —

  Desired value to use with a target-based scaling policy.

# File 'game_lift/cfn_fleet.rb', line 1662

def initialize(target_value:)
  @target_value = target_value
  Jsii::Type.check_type(@target_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "targetValue")
end

Instance Attribute Details

#target_value ⇒ Numeric (readonly)

Desired value to use with a target-based scaling policy.

The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html#cfn-gamelift-fleet-targetconfiguration-targetvalue

# File 'game_lift/cfn_fleet.rb', line 1673

def target_value
  @target_value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'game_lift/cfn_fleet.rb', line 1675

def self.jsii_properties
  {
    :target_value => "targetValue",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'game_lift/cfn_fleet.rb', line 1681

def to_jsii
  result = {}
  result.merge!({
    "targetValue" => @target_value,
  })
  result.compact
end