AWS cli documentation change
Summary
Added support for LogAlarms in describe-alarms command, including new alarm type parameter, output structure, and configuration details for log-based alarms.
Security assessment
The change documents new IAM role requirements (ScheduledQueryRoleARN, ActionLogLineRoleArn) for log alarms, which are security-relevant configurations. However, there's no evidence of addressing a specific vulnerability or security incident.
Diff
diff --git a/cli/latest/reference/cloudwatch/describe-alarms.md b/cli/latest/reference/cloudwatch/describe-alarms.md index a61bee5b6..66c09ce68 100644 --- a//cli/latest/reference/cloudwatch/describe-alarms.md +++ b//cli/latest/reference/cloudwatch/describe-alarms.md @@ -15 +15 @@ - * [AWS CLI 2.35.11 Command Reference](../../index.html) » + * [AWS CLI 2.35.13 Command Reference](../../index.html) » @@ -66 +66 @@ See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/monito -`describe-alarms` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument. When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `MetricAlarms`, `CompositeAlarms` +`describe-alarms` is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the `--no-paginate` argument. When using `--output text` and the `--query` argument on a paginated response, the `--query` argument must extract data from the results of the following query expressions: `MetricAlarms`, `CompositeAlarms`, `LogAlarms` @@ -147 +147 @@ Syntax: -> Use this parameter to specify whether you want the operation to return metric alarms or composite alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms exist in the account. +> Use this parameter to specify whether you want the operation to return metric alarms, composite alarms, or log alarms. If you omit this parameter, only metric alarms are returned, even if composite alarms or log alarms exist in the account. @@ -149 +149 @@ Syntax: -> For example, if you omit this parameter or specify `MetricAlarms` , the operation returns only a list of metric alarms. It does not return any composite alarms, even if composite alarms exist in the account. +> For example, if you omit this parameter or specify `MetricAlarms` , the operation returns only a list of metric alarms. It does not return any composite alarms or log alarms, even if they exist in the account. @@ -151 +151,3 @@ Syntax: -> If you specify `CompositeAlarms` , the operation returns only a list of composite alarms, and does not return any metric alarms. +> If you specify `CompositeAlarms` , the operation returns only a list of composite alarms, and does not return any metric alarms or log alarms. +> +> If you specify `LogAlarms` , the operation returns only a list of log alarms, and does not return any metric alarms or composite alarms. @@ -158,0 +161 @@ Syntax: +>> * `LogAlarm` @@ -1203,0 +1207,29 @@ MetricAlarms -> (list) +>> EvaluationWindow -> (tagged union structure) +>> +>>> The evaluation window that the alarm uses to select the range of metric data that it evaluates. This is either a sliding window or a wall clock window. For more information, see [Alarm evaluation windows](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/alarm-evaluation-window.html) in the _CloudWatch User Guide_ . +>>> +>>> ### Note +>>> +>>> This is a Tagged Union structure. Only one of the following top level keys can be set: `WallClockWindow`, `SlidingWindow`. +>>> +>>> WallClockWindow -> (structure) +>>> +>>>> A wall clock window, which aligns the evaluated range to fixed clock boundaries that match the alarm’s period, such as the top of the hour, midnight, or the start of the calendar week. +>>>> +>>>> Timezone -> (string) +>>>> +>>>>> The time zone to use when the alarm aligns the evaluation window to clock boundaries. You can specify an IANA time zone name (for example, `America/New_York` ), a fixed UTC offset (for example, `+05:30` ), or an offset-prefixed identifier (for example, `UTC+05:30` ). The offset must be aligned to a multiple of 5 minutes. If you don’t specify a time zone, CloudWatch uses `UTC` . +>>>>> +>>>>> The time zone affects window alignment for all periods, including periods of one hour or shorter. +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `50` +>>>>> + +>>> +>>> SlidingWindow -> (structure) +>>> +>>>> A sliding window, which advances each time the alarm is evaluated, forming a rolling time window. This is the default evaluation window. +>> @@ -1259,0 +1292,344 @@ MetricAlarms -> (list) +LogAlarms -> (list) + +> The information about any log alarms returned by the operation. +> +> (structure) +> +>> The details about a log alarm. +>> +>> AlarmName -> (string) +>> +>>> The name of the alarm. +>>> +>>> Constraints: +>>> +>>> * min: `1` +>>> * max: `255` +>>> + +>> +>> AlarmArn -> (string) +>> +>>> The Amazon Resource Name (ARN) of the alarm. +>>> +>>> Constraints: +>>> +>>> * min: `1` +>>> * max: `1600` +>>> + +>> +>> AlarmDescription -> (string) +>> +>>> The description of the alarm. +>>> +>>> Constraints: +>>> +>>> * min: `0` +>>> * max: `1024` +>>> + +>> +>> AlarmConfigurationUpdatedTimestamp -> (timestamp) +>> +>>> The time stamp of the last update to the alarm configuration. +>> +>> ActionsEnabled -> (boolean) +>> +>>> Indicates whether actions should be executed during any changes to the alarm state. +>> +>> OKActions -> (list) +>> +>>> 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). +>>> +>>> Constraints: +>>> +>>> * max: `5` +>>> + +>>> +>>> (string) +>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `1024` +>>>> + +>> +>> AlarmActions -> (list) +>> +>>> 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). +>>> +>>> Constraints: +>>> +>>> * max: `5` +>>> + +>>> +>>> (string) +>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `1024` +>>>> + +>> +>> InsufficientDataActions -> (list) +>> +>>> 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). +>>> +>>> Constraints: +>>> +>>> * max: `5` +>>> + +>>> +>>> (string) +>>> +>>>> Constraints: +>>>> +>>>> * min: `1` +>>>> * max: `1024` +>>>> + +>> +>> StateValue -> (string) +>> +>>> The state value for the alarm. +>>> +>>> Possible values: +>>> +>>> * `OK` +>>> * `ALARM` +>>> * `INSUFFICIENT_DATA` +>>> + +>> +>> StateReason -> (string) +>> +>>> An explanation for the alarm state, in text format. +>>> +>>> Constraints: +>>> +>>> * min: `0` +>>> * max: `1023` +>>> + +>> +>> StateReasonData -> (string) +>> +>>> An explanation for the alarm state, in JSON format. +>>> +>>> Constraints: +>>> +>>> * min: `0` +>>> * max: `4000` +>>> + +>> +>> StateUpdatedTimestamp -> (timestamp) +>> +>>> The time stamp of the last update to the value of either the `StateValue` or `EvaluationState` parameters. +>> +>> ScheduledQueryConfiguration -> (structure) +>>