interface CloudWatchAlarmDefinitionProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.Mixins.Preview.AWS.EMR.Mixins.CfnInstanceGroupConfigPropsMixin.CloudWatchAlarmDefinitionProperty |
 Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsemr/mixins#CfnInstanceGroupConfigPropsMixin_CloudWatchAlarmDefinitionProperty |
 Java | software.amazon.awscdk.mixins.preview.services.emr.mixins.CfnInstanceGroupConfigPropsMixin.CloudWatchAlarmDefinitionProperty |
 Python | aws_cdk.mixins_preview.aws_emr.mixins.CfnInstanceGroupConfigPropsMixin.CloudWatchAlarmDefinitionProperty |
 TypeScript | @aws-cdk/mixins-preview » aws_emr » mixins » CfnInstanceGroupConfigPropsMixin » CloudWatchAlarmDefinitionProperty |
CloudWatchAlarmDefinition is a subproperty of the ScalingTrigger property, which determines when to trigger an automatic scaling activity.
Scaling activity begins when you satisfy the defined alarm conditions.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as emr_mixins } from '@aws-cdk/mixins-preview/aws-emr';
const cloudWatchAlarmDefinitionProperty: emr_mixins.CfnInstanceGroupConfigPropsMixin.CloudWatchAlarmDefinitionProperty = {
comparisonOperator: 'comparisonOperator',
dimensions: [{
key: 'key',
value: 'value',
}],
evaluationPeriods: 123,
metricName: 'metricName',
namespace: 'namespace',
period: 123,
statistic: 'statistic',
threshold: 123,
unit: 'unit',
};
Properties
| Name | Type | Description |
|---|---|---|
| comparison | string | Determines how the metric specified by MetricName is compared to the value specified by Threshold . |
| dimensions? | IResolvable | (IResolvable | Metric)[] | A CloudWatch metric dimension. |
| evaluation | number | The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity. |
| metric | string | The name of the CloudWatch metric that is watched to determine an alarm condition. |
| namespace? | string | The namespace for the CloudWatch metric. |
| period? | number | The period, in seconds, over which the statistic is applied. |
| statistic? | string | The statistic to apply to the metric associated with the alarm. |
| threshold? | number | The value against which the specified statistic is compared. |
| unit? | string | The unit of measure associated with the CloudWatch metric being watched. |
comparisonOperator?
Type:
string
(optional)
Determines how the metric specified by MetricName is compared to the value specified by Threshold .
dimensions?
Type:
IResolvable | (IResolvable | Metric)[]
(optional)
A CloudWatch metric dimension.
evaluationPeriods?
Type:
number
(optional)
The number of periods, in five-minute increments, during which the alarm condition must exist before the alarm triggers automatic scaling activity.
The default value is 1 .
metricName?
Type:
string
(optional)
The name of the CloudWatch metric that is watched to determine an alarm condition.
namespace?
Type:
string
(optional)
The namespace for the CloudWatch metric.
The default is AWS/ElasticMapReduce .
period?
Type:
number
(optional)
The period, in seconds, over which the statistic is applied.
CloudWatch metrics for Amazon EMR are emitted every five minutes (300 seconds), so if you specify a CloudWatch metric, specify 300 .
statistic?
Type:
string
(optional)
The statistic to apply to the metric associated with the alarm.
The default is AVERAGE .
threshold?
Type:
number
(optional)
The value against which the specified statistic is compared.
unit?
Type:
string
(optional)
The unit of measure associated with the CloudWatch metric being watched.
The value specified for Unit must correspond to the units specified in the CloudWatch metric.