Class CfnCluster.CloudWatchAlarmDefinitionProperty

CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which determines when to trigger an automatic scaling activity.

Inheritance

System.Object

CfnCluster.CloudWatchAlarmDefinitionProperty

Implements

CfnCluster.ICloudWatchAlarmDefinitionProperty

Namespace: Amazon.CDK.AWS.EMR

Assembly: Amazon.CDK.AWS.EMR.dll

Syntax (csharp)

public class CloudWatchAlarmDefinitionProperty : Object, CfnCluster.ICloudWatchAlarmDefinitionProperty

Syntax (vb)

Public Class CloudWatchAlarmDefinitionProperty
    Inherits Object
    Implements CfnCluster.ICloudWatchAlarmDefinitionProperty

Remarks

Scaling activity begins when you satisfy the defined alarm conditions.

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

CloudWatchAlarmDefinitionProperty cloudWatchAlarmDefinitionProperty = 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"
};

Synopsis

Constructors

CloudWatchAlarmDefinitionProperty()

Properties

ComparisonOperator	Determines how the metric specified by `MetricName` is compared to the value specified by `Threshold` .
Dimensions	A CloudWatch metric dimension.
EvaluationPeriods	The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity.
MetricName	The name of the CloudWatch metric that is watched to determine an alarm condition.
Namespace	The namespace for the CloudWatch metric.
Period	The period, in seconds, over which the statistic is applied.
Statistic	The statistic to apply to the metric associated with the alarm.
Threshold	The value against which the specified statistic is compared.
Unit	The unit of measure associated with the CloudWatch metric being watched.

Constructors

CloudWatchAlarmDefinitionProperty()

public CloudWatchAlarmDefinitionProperty()

Properties

ComparisonOperator

Determines how the metric specified by MetricName is compared to the value specified by Threshold .

public string ComparisonOperator { get; set; }

Property Value

System.String

Remarks

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

Dimensions

A CloudWatch metric dimension.

public object Dimensions { get; set; }

Property Value

System.Object

Remarks

EvaluationPeriods

The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity.

public Nullable<double> EvaluationPeriods { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

The default value is 1 .

MetricName

The name of the CloudWatch metric that is watched to determine an alarm condition.

public string MetricName { get; set; }

Property Value

System.String

Remarks

Namespace

The namespace for the CloudWatch metric.

public string Namespace { get; set; }

Property Value

System.String

Remarks

The default is AWS/ElasticMapReduce .

Period

The period, in seconds, over which the statistic is applied.

public double Period { get; set; }

Property Value

System.Double

Remarks

EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300 .

Statistic

The statistic to apply to the metric associated with the alarm.

public string Statistic { get; set; }

Property Value

System.String

Remarks

The default is AVERAGE .

Threshold

The value against which the specified statistic is compared.

public double Threshold { get; set; }

Property Value

System.Double

Remarks

Unit

The unit of measure associated with the CloudWatch metric being watched.

public string Unit { get; set; }

Property Value

System.String

Remarks

The value specified for Unit must correspond to the units specified in the CloudWatch metric.

Implements

CfnCluster.ICloudWatchAlarmDefinitionProperty