Class: Alarm

CloudWatch.Alarm

new Alarm()

Properties:
Name Type Description
ActionsEnabled Boolean Required: No. Indicates whether or not actions should be executed during any changes to the alarm's state.Update requires: No interruption
AlarmActions String Required: No. The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). For more information about creating alarms and the actions you can specify, see Creating Amazon CloudWatch Alarms in the Amazon CloudWatch Developer Guide.Update requires: No interruption
AlarmDescription String Required: No. The description for the alarm.Update requires: No interruption
AlarmName String Required: No. A name for the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name. For more information, see Name Type.ImportantIf you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.Update requires: Replacement
ComparisonOperator String Required: Yes. The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.You can specify the following values: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThresholdUpdate requires: No interruption
Dimensions CloudWatchMetricDimensionPropertyType Required: No. The dimensions for the alarm's associated metric.Update requires: No interruption
EvaluationPeriods String Required: Yes. The number of periods over which data is compared to the specified threshold.Update requires: No interruption
InsufficientDataActions String Required: No. The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.Update requires: No interruption
MetricName String Required: Yes. The name for the alarm's associated metric. For more information about the metrics that you can specify, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch Developer Guide.Update requires: No interruption
Namespace String Required: Yes. The namespace for the alarm's associated metric.Update requires: No interruption
OKActions String Required: No. The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.Update requires: No interruption
Period String Required: Yes. The time over which the specified statistic is applied. You must specify a time in seconds that is also a multiple of 60.Update requires: No interruption
Statistic String Required: Yes. The statistic to apply to the alarm's associated metric.You can specify the following values: SampleCount | Average | Sum | Minimum | MaximumUpdate requires: No interruption
Threshold String Required: Yes. The value against which the specified statistic is compared.Update requires: No interruption
Unit String Required: No. The unit for the alarm's associated metric.You can specify the following values: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | NoneUpdate requires: No interruption
Source:

Extends

  • WKResource

CloudWatch.Alarm

new Alarm()

Properties:
Name Type Description
ActionsEnabled Boolean Required: No. Indicates whether or not actions should be executed during any changes to the alarm's state.Update requires: No interruption
AlarmActions String Required: No. The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). For more information about creating alarms and the actions you can specify, see Creating Amazon CloudWatch Alarms in the Amazon CloudWatch Developer Guide.Update requires: No interruption
AlarmDescription String Required: No. The description for the alarm.Update requires: No interruption
AlarmName String Required: No. A name for the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name. For more information, see Name Type.ImportantIf you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.Update requires: Replacement
ComparisonOperator String Required: Yes. The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.You can specify the following values: GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThresholdUpdate requires: No interruption
Dimensions CloudWatchMetricDimensionPropertyType Required: No. The dimensions for the alarm's associated metric.Update requires: No interruption
EvaluationPeriods String Required: Yes. The number of periods over which data is compared to the specified threshold.Update requires: No interruption
InsufficientDataActions String Required: No. The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.Update requires: No interruption
MetricName String Required: Yes. The name for the alarm's associated metric. For more information about the metrics that you can specify, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch Developer Guide.Update requires: No interruption
Namespace String Required: Yes. The namespace for the alarm's associated metric.Update requires: No interruption
OKActions String Required: No. The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only action supported is publishing to an Amazon SNS topic or an Amazon Auto Scaling policy.Update requires: No interruption
Period String Required: Yes. The time over which the specified statistic is applied. You must specify a time in seconds that is also a multiple of 60.Update requires: No interruption
Statistic String Required: Yes. The statistic to apply to the alarm's associated metric.You can specify the following values: SampleCount | Average | Sum | Minimum | MaximumUpdate requires: No interruption
Threshold String Required: Yes. The value against which the specified statistic is compared.Update requires: No interruption
Unit String Required: No. The unit for the alarm's associated metric.You can specify the following values: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | NoneUpdate requires: No interruption
Source:

Extends

  • WKResource