Interface CfnContainerFleet.IScalingPolicyProperty

Rule that controls how a fleet is scaled.

Namespace: Amazon.CDK.AWS.GameLift

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IScalingPolicyProperty

Syntax (vb)

Public Interface IScalingPolicyProperty

Remarks

Scaling policies are uniquely identified by the combination of name and fleet ID.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.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 scalingPolicyProperty = new ScalingPolicyProperty {
    MetricName = "metricName",
    Name = "name",

    // the properties below are optional
    ComparisonOperator = "comparisonOperator",
    EvaluationPeriods = 123,
    PolicyType = "policyType",
    ScalingAdjustment = 123,
    ScalingAdjustmentType = "scalingAdjustmentType",
    TargetConfiguration = new TargetConfigurationProperty {
        TargetValue = 123
    },
    Threshold = 123
};

Synopsis

Properties

ComparisonOperator	Comparison operator to use when measuring a metric against the threshold value.
EvaluationPeriods	Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
MetricName	Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment.
Name	A descriptive label that is associated with a fleet's scaling policy.
PolicyType	The type of scaling policy to create.
ScalingAdjustment	Amount of adjustment to make, based on the scaling adjustment type.
ScalingAdjustmentType	The type of adjustment to make to a fleet's instance count.
TargetConfiguration	An object that contains settings for a target-based scaling policy.
Threshold	Metric value used to trigger a scaling event.

Properties

ComparisonOperator

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

virtual string ComparisonOperator { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-comparisonoperator

EvaluationPeriods

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

virtual Nullable<double> EvaluationPeriods { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-evaluationperiods

MetricName

Name of the Amazon GameLift Servers-defined metric that is used to trigger a scaling adjustment.

string MetricName { get; }

Property Value

System.String

Remarks

For detailed descriptions of fleet metrics, see Monitor Amazon GameLift Servers with Amazon CloudWatch .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-metricname

Name

A descriptive label that is associated with a fleet's scaling policy.

string Name { get; }

Property Value

System.String

Remarks

Policy names do not need to be unique.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-name

PolicyType

The type of scaling policy to create.

virtual string PolicyType { get; }

Property Value

System.String

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-policytype

ScalingAdjustment

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

virtual Nullable<double> ScalingAdjustment { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-scalingadjustment

ScalingAdjustmentType

The type of adjustment to make to a fleet's instance count.

virtual string ScalingAdjustmentType { get; }

Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-scalingadjustmenttype

TargetConfiguration

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

virtual object TargetConfiguration { get; }

Property Value

System.Object

Remarks

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

Threshold

Metric value used to trigger a scaling event.

virtual Nullable<double> Threshold { get; }

Property Value

System.Nullable<System.Double>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-containerfleet-scalingpolicy.html#cfn-gamelift-containerfleet-scalingpolicy-threshold