AWSCloudWatchPutMetricAlarmInput Class Reference

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

Overview

Describes the inputs for PutMetricAlarm.

Required parameters: [AlarmName, MetricName, Namespace, Statistic, Period, EvaluationPeriods, Threshold, ComparisonOperator]

  actionsEnabled

Indicates whether or not actions should be executed during any changes to the alarm's state.

@property (nonatomic, strong) NSNumber *actionsEnabled

Declared In

AWSCloudWatchModel.h

  alarmActions

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 Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

@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 descriptive name for the alarm. This name must be unique within the user's 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

  dimensions

The dimensions for the alarm's associated metric.

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

Declared In

AWSCloudWatchModel.h

  evaluationPeriods

The number of periods over which data is compared to the specified threshold.

@property (nonatomic, strong) NSNumber *evaluationPeriods

Declared In

AWSCloudWatchModel.h

  insufficientDataActions

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 Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

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

Declared In

AWSCloudWatchModel.h

  metricName

The name for the alarm's associated metric.

@property (nonatomic, strong) NSString *metricName

Declared In

AWSCloudWatchModel.h

  namespace

The namespace for the alarm's associated metric.

@property (nonatomic, strong) NSString *namespace

Declared In

AWSCloudWatchModel.h

  OKActions

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 Name (ARN).

Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.

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

Declared In

AWSCloudWatchModel.h

  period

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

@property (nonatomic, strong) NSNumber *period

Declared In

AWSCloudWatchModel.h

  statistic

The statistic to apply to the alarm's associated metric.

@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

  unit

The statistic's unit of measure. 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.

Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.

@property (nonatomic, assign) AWSCloudWatchStandardUnit unit

Declared In

AWSCloudWatchModel.h