Interface CfnCluster.IScalingRuleProperty

ScalingRule is a subproperty of the AutoScalingPolicy property type.

Namespace: Amazon.CDK.AWS.EMR

Assembly: Amazon.CDK.AWS.EMR.dll

Syntax (csharp)

public interface IScalingRuleProperty

Syntax (vb)

Public Interface IScalingRuleProperty

Remarks

ScalingRule defines the scale-in or scale-out rules for scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.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.EMR;

ScalingRuleProperty scalingRuleProperty = new ScalingRuleProperty {
    Action = new ScalingActionProperty {
        SimpleScalingPolicyConfiguration = new SimpleScalingPolicyConfigurationProperty {
            ScalingAdjustment = 123,

            // the properties below are optional
            AdjustmentType = "adjustmentType",
            CoolDown = 123
        },

        // the properties below are optional
        Market = "market"
    },
    Name = "name",
    Trigger = new ScalingTriggerProperty {
        CloudWatchAlarmDefinition = new CloudWatchAlarmDefinitionProperty {
            ComparisonOperator = "comparisonOperator",
            MetricName = "metricName",
            Period = 123,
            Threshold = 123,

            // the properties below are optional
            Dimensions = new [] { new MetricDimensionProperty {
                Key = "key",
                Value = "value"
            } },
            EvaluationPeriods = 123,
            Namespace = "namespace",
            Statistic = "statistic",
            Unit = "unit"
        }
    },

    // the properties below are optional
    Description = "description"
};

Synopsis

Properties

Action	The conditions that trigger an automatic scaling activity.
Description	A friendly, more verbose description of the automatic scaling rule.
Name	The name used to identify an automatic scaling rule.
Trigger	The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

Properties

Action

The conditions that trigger an automatic scaling activity.

object Action { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-action

Description

A friendly, more verbose description of the automatic scaling rule.

virtual string Description { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-description

Name

The name used to identify an automatic scaling rule.

string Name { get; }

Property Value

System.String

Remarks

Rule names must be unique within a scaling policy.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-name

Trigger

The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

object Trigger { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticmapreduce-cluster-scalingrule.html#cfn-elasticmapreduce-cluster-scalingrule-trigger