aws_cloudwatch_metric_alarm
account_id
Type: STRING
actions_enabled
Type: BOOLEAN
Provider name: ActionsEnabled
Description: Indicates whether actions should be executed during any changes to the alarm state.
alarm_actions
Type: UNORDERED_LIST_STRING
Provider name: AlarmActions
Description: 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).
alarm_arn
Type: STRING
Provider name: AlarmArn
Description: The Amazon Resource Name (ARN) of the alarm.
alarm_configuration_updated_timestamp
Type: TIMESTAMP
Provider name: AlarmConfigurationUpdatedTimestamp
Description: The time stamp of the last update to the alarm configuration.
alarm_description
Type: STRING
Provider name: AlarmDescription
Description: The description of the alarm.
alarm_name
Type: STRING
Provider name: AlarmName
Description: The name of the alarm.
comparison_operator
Type: STRING
Provider name: ComparisonOperator
Description: The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
datapoints_to_alarm
Type: INT32
Provider name: DatapointsToAlarm
Description: The number of data points that must be breaching to trigger the alarm.
dimensions
Type: UNORDERED_LIST_STRUCT
Provider name: Dimensions
Description: The dimensions for the metric associated with the alarm.
name
Type: STRING
Provider name: Name
Description: The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).
value
Type: STRING
Provider name: Value
Description: The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
evaluate_low_sample_count_percentile
Type: STRING
Provider name: EvaluateLowSampleCountPercentile
Description: Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
evaluation_periods
Type: INT32
Provider name: EvaluationPeriods
Description: The number of periods over which data is compared to the specified threshold.
evaluation_state
Type: STRING
Provider name: EvaluationState
Description: If the value of this field is PARTIAL_DATA, the alarm is being evaluated based on only partial data. This happens if the query used for the alarm returns more than 10,000 metrics. For more information, see Create alarms on Metrics Insights queries.
extended_statistic
Type: STRING
Provider name: ExtendedStatistic
Description: The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
insufficient_data_actions
Type: UNORDERED_LIST_STRING
Provider name: InsufficientDataActions
Description: 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).
metric_name
Type: STRING
Provider name: MetricName
Description: The name of the metric associated with the alarm, if this is an alarm based on a single metric.
metrics
Type: UNORDERED_LIST_STRUCT
Provider name: Metrics
Description: An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.
account_id
Type: STRING
Provider name: AccountId
Description: The ID of the account where the metrics are located. If you are performing a GetMetricData operation in a monitoring account, use this to specify which account to retrieve this metric from. If you are performing a PutMetricAlarm operation, use this to specify which account contains the metric that the alarm is watching.
expression
Type: STRING
Provider name: Expression
Description: This field can contain either a Metrics Insights query, or a metric math expression to be performed on the returned data. For more information about Metrics Insights queries, see Metrics Insights query components and syntax in the Amazon CloudWatch User Guide. A math expression can use the Id of the other metrics or queries to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide. Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.
id
Type: STRING
Provider name: Id
Description: A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.
label
Type: STRING
Provider name: Label
Description: A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default. You can put dynamic expressions into a label, so that it is more descriptive. For more information, see Using Dynamic Labels.
metric_stat
Type: STRUCT
Provider name: MetricStat
Description: The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.
metric
Type: STRUCT
Provider name: Metric
Description: The metric to return, including the metric name, namespace, and dimensions.
dimensions
Type: UNORDERED_LIST_STRUCT
Provider name: Dimensions
Description: The dimensions for the metric.
name
Type: STRING
Provider name: Name
Description: The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:).
value
Type: STRING
Provider name: Value
Description: The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character.
metric_name
Type: STRING
Provider name: MetricName
Description: The name of the metric. This is a required field.
namespace
Type: STRING
Provider name: Namespace
Description: The namespace of the metric.
period
Type: INT32
Provider name: Period
Description: The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second. If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:- Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
- Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
- Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
stat
Type: STRING
Provider name: Stat
Description: The statistic to return. It can include any CloudWatch statistic or extended statistic.
unit
Type: STRING
Provider name: Unit
Description: When you are using a Put operation, this defines what unit you want to use when storing the metric. In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.
period
Type: INT32
Provider name: Period
Description: The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.
return_data
Type: BOOLEAN
Provider name: ReturnData
Description: When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify false. If you omit this, the default of true is used. When used in PutMetricAlarm, specify true for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.
namespace
Type: STRING
Provider name: Namespace
Description: The namespace of the metric associated with the alarm.
ok_actions
Type: UNORDERED_LIST_STRING
Provider name: OKActions
Description: The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
period
Type: INT32
Provider name: Period
Description: The period, in seconds, over which the statistic is applied.
state_reason
Type: STRING
Provider name: StateReason
Description: An explanation for the alarm state, in text format.
state_reason_data
Type: STRING
Provider name: StateReasonData
Description: An explanation for the alarm state, in JSON format.
state_transitioned_timestamp
Type: TIMESTAMP
Provider name: StateTransitionedTimestamp
Description: The date and time that the alarm’s StateValue most recently changed.
state_updated_timestamp
Type: TIMESTAMP
Provider name: StateUpdatedTimestamp
Description: The time stamp of the last update to the value of either the StateValue or EvaluationState parameters.
state_value
Type: STRING
Provider name: StateValue
Description: The state value for the alarm.
statistic
Type: STRING
Provider name: Statistic
Description: The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.
Type: UNORDERED_LIST_STRING
threshold
Type: DOUBLE
Provider name: Threshold
Description: The value to compare with the specified statistic.
threshold_metric_id
Type: STRING
Provider name: ThresholdMetricId
Description: In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
treat_missing_data
Type: STRING
Provider name: TreatMissingData
Description: Sets how this alarm is to handle missing data points. The valid values are breaching, notBreaching, ignore, and missing. For more information, see Configuring how CloudWatch alarms treat missing data. If this parameter is omitted, the default behavior of missing is used.
unit
Type: STRING
Provider name: Unit
Description: The unit of the metric associated with the alarm.
