AWSCloudWatchPutMetricAlarmInput

Objective-C

@interface AWSCloudWatchPutMetricAlarmInput

Swift

class AWSCloudWatchPutMetricAlarmInput

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable actionsEnabled;

    Swift

    var actionsEnabled: NSNumber? { get set }

  • 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

    Declaration

    Objective-C

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

    Swift

    var alarmActions: [String]? { get set }

  • The description for the alarm.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable alarmDescription;

    Swift

    var alarmDescription: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable alarmName;

    Swift

    var alarmName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSCloudWatchComparisonOperator comparisonOperator;

    Swift

    var comparisonOperator: AWSCloudWatchComparisonOperator { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable datapointsToAlarm;

    Swift

    var datapointsToAlarm: NSNumber? { get set }

  • The dimensions for the metric specified in MetricName.

    Declaration

    Objective-C

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

    Swift

    var dimensions: [AWSCloudWatchDimension]? { get set }

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable evaluateLowSampleCountPercentile;

    Swift

    var evaluateLowSampleCountPercentile: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable evaluationPeriods;

    Swift

    var evaluationPeriods: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable extendedStatistic;

    Swift

    var extendedStatistic: String? { get set }

  • 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

    Declaration

    Objective-C

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

    Swift

    var insufficientDataActions: [String]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable metricName;

    Swift

    var metricName: String? { get set }

  • 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.

    Declaration

    Objective-C

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

    Swift

    var metrics: [AWSCloudWatchMetricDataQuery]? { get set }

  • The namespace for the metric associated specified in MetricName.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable namespace;

    Swift

    var namespace: String? { get set }

  • 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

    Declaration

    Objective-C

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

    Swift

    var okActions: [String]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable period;

    Swift

    var period: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSCloudWatchStatistic statistic;

    Swift

    var statistic: AWSCloudWatchStatistic { get set }

  • The value against which the specified statistic is compared.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable threshold;

    Swift

    var threshold: NSNumber? { get set }

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable treatMissingData;

    Swift

    var treatMissingData: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSCloudWatchStandardUnit unit;

    Swift

    var unit: AWSCloudWatchStandardUnit { get set }