AWSCloudWatchPutMetricAlarmInput Class Reference

Inherits from AWSRequest : AWSModel : AWSMTLModel
Declared in AWSCloudWatchModel.h
AWSCloudWatchModel.m

  actionsEnabled

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

@property (nonatomic, strong) NSNumber *actionsEnabled

Declared In

AWSCloudWatchModel.h

  alarmActions

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

@property (nonatomic, strong) NSArray<NSString*> *alarmActions

Declared In

AWSCloudWatchModel.h

  alarmDescription

The description for the alarm.

@property (nonatomic, strong) NSString *alarmDescription

Declared In

AWSCloudWatchModel.h

  alarmName

The name for the alarm. This name must be unique within your AWS account.

@property (nonatomic, strong) NSString *alarmName

Declared In

AWSCloudWatchModel.h

  comparisonOperator

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

@property (nonatomic, assign) AWSCloudWatchComparisonOperator comparisonOperator

Declared In

AWSCloudWatchModel.h

  datapointsToAlarm

The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

@property (nonatomic, strong) NSNumber *datapointsToAlarm

Declared In

AWSCloudWatchModel.h

  dimensions

The dimensions for the metric specified in MetricName.

@property (nonatomic, strong) NSArray<AWSCloudWatchDimension*> *dimensions

Declared In

AWSCloudWatchModel.h

  evaluateLowSampleCountPercentile

Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

Valid Values: evaluate | ignore

@property (nonatomic, strong) NSString *evaluateLowSampleCountPercentile

Declared In

AWSCloudWatchModel.h

  evaluationPeriods

The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N.

An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

@property (nonatomic, strong) NSNumber *evaluationPeriods

Declared In

AWSCloudWatchModel.h

  extendedStatistic

The percentile statistic for the metric specified in MetricName. Specify a value between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

@property (nonatomic, strong) NSString *extendedStatistic

Declared In

AWSCloudWatchModel.h

  insufficientDataActions

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

@property (nonatomic, strong) NSArray<NSString*> *insufficientDataActions

Declared In

AWSCloudWatchModel.h

  metricName

The name for the metric associated with the alarm.

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

@property (nonatomic, strong) NSString *metricName

Declared In

AWSCloudWatchModel.h

  metrics

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. Each item in the Metrics array either retrieves a metric or performs a math expression.

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

@property (nonatomic, strong) NSArray<AWSCloudWatchMetricDataQuery*> *metrics

Declared In

AWSCloudWatchModel.h

  namespace

The namespace for the metric associated specified in MetricName.

@property (nonatomic, strong) NSString *namespace

Declared In

AWSCloudWatchModel.h

  OKActions

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

@property (nonatomic, strong) NSArray<NSString*> *OKActions

Declared In

AWSCloudWatchModel.h

  period

The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

@property (nonatomic, strong) NSNumber *period

Declared In

AWSCloudWatchModel.h

  statistic

The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

@property (nonatomic, assign) AWSCloudWatchStatistic statistic

Declared In

AWSCloudWatchModel.h

  threshold

The value against which the specified statistic is compared.

@property (nonatomic, strong) NSNumber *threshold

Declared In

AWSCloudWatchModel.h

  treatMissingData

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.

Valid Values: breaching | notBreaching | ignore | missing

@property (nonatomic, strong) NSString *treatMissingData

Declared In

AWSCloudWatchModel.h

  unit

The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.

If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

@property (nonatomic, assign) AWSCloudWatchStandardUnit unit

Declared In

AWSCloudWatchModel.h