Class CfnFleet.TargetConfigurationProperty

Settings for a target-based scaling policy.

Inheritance

object

CfnFleet.TargetConfigurationProperty

Implements

CfnFleet.ITargetConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFleet.TargetConfigurationProperty : CfnFleet.ITargetConfigurationProperty

Syntax (vb)

Public Class CfnFleet.TargetConfigurationProperty Implements CfnFleet.ITargetConfigurationProperty

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift;

             var targetConfigurationProperty = new TargetConfigurationProperty {
                 TargetValue = 123
             };

Synopsis

Constructors

TargetConfigurationProperty()

Settings for a target-based scaling policy.

Properties

TargetValue

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

Constructors

TargetConfigurationProperty()

Settings for a target-based scaling policy.

public TargetConfigurationProperty()

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-targetconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GameLift;

             var targetConfigurationProperty = new TargetConfigurationProperty {
                 TargetValue = 123
             };

Properties

TargetValue

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

public double TargetValue { get; set; }

Property Value

double

Remarks

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

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

Implements

CfnFleet.ITargetConfigurationProperty