MetricAlarm
cloudwatch.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | cloudwatch-controller/apis/v1alpha1#MetricAlarm |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | MetricAlarm |
| ListKind | MetricAlarmList |
| Plural | metricalarms |
| Singular | metricalarm |
The details about a metric alarm.
Spec
actionsEnabled: boolean
alarmActions:
- string
alarmDescription: string
comparisonOperator: string
datapointsToAlarm: integer
dimensions:
- name: string
value: string
evaluateLowSampleCountPercentile: string
evaluationPeriods: integer
extendedStatistic: string
insufficientDataActions:
- string
metricName: string
metrics:
- accountID: string
expression: string
id: string
label: string
metricStat:
metric:
dimensions:
- name: string
value: string
metricName: string
namespace: string
period: integer
stat: string
unit: string
period: integer
returnData: boolean
name: string
namespace: string
oKActions:
- string
period: integer
statistic: string
tags:
- key: string
value: string
threshold: number
thresholdMetricID: string
treatMissingData: string
unit: string
| Field | Description |
|---|---|
| actionsEnabled Optional | boolean Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. |
| alarmActions Optional | array 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: EC2 actions: * arn:aws:automate:region:ec2:stop * arn:aws:automate:region:ec2:terminate * arn:aws:automate:region:ec2:reboot * arn:aws:automate:region:ec2:recover * 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 * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 Autoscaling action: * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name SNS notification action: * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name SSM integration actions: * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name |
| alarmActions.[] Required | string |
| comparisonOperator Required | string The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models. |
| datapointsToAlarm Optional | integer The number of data points 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the Amazon CloudWatch User Guide. |
| dimensions Optional | array The dimensions for the metric specified in MetricName. |
| dimensions.[] Required | object A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension. |
| You can assign up to 30 dimensions to a metric. | |
| dimensions.[].value Optional | string |
| evaluateLowSampleCountPercentile Optional | string 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples). Valid Values: evaluate |
| evaluationPeriods Required | integer 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. |
| extendedStatistic Optional | string 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. |
| insufficientDataActions Optional | array 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: EC2 actions: * arn:aws:automate:region:ec2:stop * arn:aws:automate:region:ec2:terminate * arn:aws:automate:region:ec2:reboot * arn:aws:automate:region:ec2:recover * 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 * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 Autoscaling action: * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name SNS notification action: * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name SSM integration actions: * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name |
| insufficientDataActions.[] Required | string |
| metrics Optional | array An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array. Each item in the Metrics array either retrieves a metric or performs a math expression. One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnData to true for this object in the array. For more information, see MetricDataQuery (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDataQuery.html). 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. |
| metrics.[] Required | object This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations. |
| When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a Metrics Insights query or a math expression. A single GetMetricData call can include up to 500 MetricDataQuery structures. | |
| When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have true as the value for ReturnData. The result of this expression is the value the alarm watches. | |
| Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the Amazon CloudWatch User Guide. | |
| Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list. | |
| metrics.[].expression Optional | string |
| metrics.[].id Optional | string |
| metrics.[].label Optional | string |
| metrics.[].metricStat Optional | object This structure defines the metric to be returned, along with the statistics, period, and units. |
| metrics.[].metricStat.metric Optional | object Represents a specific metric. |
| metrics.[].metricStat.metric.dimensions Optional | array |
| metrics.[].metricStat.metric.dimensions.[] Required | object A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension. |
| You can assign up to 30 dimensions to a metric. | |
| metrics.[].metricStat.metric.dimensions.[].value Optional | string |
| metrics.[].metricStat.metric.metricName Optional | string |
| metrics.[].metricStat.metric.namespace Optional | string |
| metrics.[].metricStat.period Optional | integer |
| metrics.[].metricStat.stat Optional | string |
| metrics.[].metricStat.unit Optional | string |
| metrics.[].period Optional | integer |
| metrics.[].returnData Optional | boolean |
| name Required | string The name for the alarm. This name must be unique within the Region. The name must contain only UTF-8 characters, and can’t contain ASCII control characters |
| namespace Optional | string The namespace for the metric associated specified in MetricName. |
| oKActions Optional | array 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: EC2 actions: * arn:aws:automate:region:ec2:stop * arn:aws:automate:region:ec2:terminate * arn:aws:automate:region:ec2:reboot * arn:aws:automate:region:ec2:recover * 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 * arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0 Autoscaling action: * arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name SNS notification action: * arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name SSM integration actions: * arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name * arn:aws:ssm-incidents::account-id:responseplan/response-plan-name |
| oKActions.[] Required | string |
| statistic Optional | string 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. |
| tags Optional | array A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_TagResource.html) or UntagResource (https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_UntagResource.html). |
| tags.[] Required | object A key-value pair associated with a CloudWatch resource. |
| tags.[].value Optional | string |
| threshold Optional | number The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models. |
| thresholdMetricID Optional | string If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function. For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page. If your alarm uses this parameter, it cannot have Auto Scaling actions. |
| treatMissingData Optional | string 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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data). Valid Values: breaching |
| unit Optional | string 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 don’t specify Unit, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended. However, if the metric is published with multiple types of units and you don’t specify a unit, the alarm’s behavior is not defined and it behaves unpredictably. We recommend omitting Unit so that you don’t inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state. |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |