Class CfnContainerFleet.ScalingPolicyProperty

Rule that controls how a fleet is scaled.

Inheritance

object

CfnContainerFleet.ScalingPolicyProperty

Implements

CfnContainerFleet.IScalingPolicyProperty

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 CfnContainerFleet.ScalingPolicyProperty : CfnContainerFleet.IScalingPolicyProperty

Syntax (vb)

Public Class CfnContainerFleet.ScalingPolicyProperty Implements CfnContainerFleet.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

Constructors

ScalingPolicyProperty()

Rule that controls how a fleet is scaled.

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.

Constructors

ScalingPolicyProperty()

Rule that controls how a fleet is scaled.

public ScalingPolicyProperty()

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
             };

Properties

ComparisonOperator

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

public string? ComparisonOperator { get; set; }

Property Value

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.

public double? EvaluationPeriods { get; set; }

Property Value

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.

public string MetricName { get; set; }

Property Value

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.

public string Name { get; set; }

Property Value

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.

public string? PolicyType { get; set; }

Property Value

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.

public double? ScalingAdjustment { get; set; }

Property Value

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.

public string? ScalingAdjustmentType { get; set; }

Property Value

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.

public object? TargetConfiguration { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnContainerFleet.ITargetConfigurationProperty

Threshold

Metric value used to trigger a scaling event.

public double? Threshold { get; set; }