AWS cli: CloudWatch describe-alarms: document ActionConfiguration tag propagation
Summary
Adds reference documentation for the new ActionConfiguration/AlarmTagsPropagation structure (Enabled, IncludedTagKeys, ExcludedTagKeys) under CompositeAlarms, MetricAlarms, and LogAlarms, describing how alarm tags are included in action notifications and state-change events, plus a note that cloudwatch:ListTagsForResource is required when enabled. Also bumps the AWS CLI version reference from 2.38.1 to 2.38.2.
Security assessment
This is a feature/API reference addition for a new alarm action configuration that propagates tags into notifications. The only security-adjacent content is the incidental statement of a required IAM permission (cloudwatch:ListTagsForResource) for enabling tag propagation; there is no vulnerability, CVE, or hardening guidance being addressed, so it is a low-severity documentation change.
Evidence
>>>>> When this is `true` , you must have the `cloudwatch:ListTagsForResource` permission on the alarm to create or update it.
Diff
diff --git a/cli/latest/reference/cloudwatch/describe-alarms.md b/cli/latest/reference/cloudwatch/describe-alarms.md index 4e4bf0a..5af0291 100644 --- a//cli/latest/reference/cloudwatch/describe-alarms.md +++ b//cli/latest/reference/cloudwatch/describe-alarms.md @@ -15 +15 @@ - * [AWS CLI 2.38.1 Command Reference](../../index.html) » + * [AWS CLI 2.38.2 Command Reference](../../index.html) » @@ -627,0 +628,62 @@ CompositeAlarms -> (list) +>> +>> ActionConfiguration -> (structure) +>> +>>> Settings that change the content of the notifications and events that the alarm sends when its state changes. These settings apply to the alarm’s actions, whichever state triggers them. +>>> +>>> AlarmTagsPropagation -> (structure) +>>> +>>>> Settings for including the alarm’s tags in its action notifications and state-change events. +>>>> +>>>> Enabled -> (boolean) [required] +>>>> +>>>>> Set to `true` to include the alarm’s tags. Set to `false` to stop including them. +>>>>> +>>>>> When this is `true` , you must have the `cloudwatch:ListTagsForResource` permission on the alarm to create or update it. +>>>> +>>>> IncludedTagKeys -> (list) +>>>> +>>>>> The tag keys to include. Only the alarm’s tags with these keys are included. +>>>>> +>>>>> You can specify 1 to 50 tag keys. Each tag key must be 1 to 128 characters long. +>>>>> +>>>>> You can’t specify both `IncludedTagKeys` and `ExcludedTagKeys` . +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `50` +>>>>> + +>>>>> +>>>>> (string) +>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `1` +>>>>>> * max: `128` +>>>>>> + +>>>> +>>>> ExcludedTagKeys -> (list) +>>>> +>>>>> The tag keys to exclude. All of the alarm’s tags except those with these keys are included. +>>>>> +>>>>> You can specify 1 to 50 tag keys. Each tag key must be 1 to 128 characters long. +>>>>> +>>>>> You can’t specify both `IncludedTagKeys` and `ExcludedTagKeys` . +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `50` +>>>>> + +>>>>> +>>>>> (string) +>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `1` +>>>>>> * max: `128` +>>>>>> + @@ -1313,0 +1376,62 @@ MetricAlarms -> (list) +>> +>> ActionConfiguration -> (structure) +>> +>>> Settings that change the content of the notifications and events that the alarm sends when its state changes. These settings apply to the alarm’s actions, whichever state triggers them. +>>> +>>> AlarmTagsPropagation -> (structure) +>>> +>>>> Settings for including the alarm’s tags in its action notifications and state-change events. +>>>> +>>>> Enabled -> (boolean) [required] +>>>> +>>>>> Set to `true` to include the alarm’s tags. Set to `false` to stop including them. +>>>>> +>>>>> When this is `true` , you must have the `cloudwatch:ListTagsForResource` permission on the alarm to create or update it. +>>>> +>>>> IncludedTagKeys -> (list) +>>>> +>>>>> The tag keys to include. Only the alarm’s tags with these keys are included. +>>>>> +>>>>> You can specify 1 to 50 tag keys. Each tag key must be 1 to 128 characters long. +>>>>> +>>>>> You can’t specify both `IncludedTagKeys` and `ExcludedTagKeys` . +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `50` +>>>>> + +>>>>> +>>>>> (string) +>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `1` +>>>>>> * max: `128` +>>>>>> + +>>>> +>>>> ExcludedTagKeys -> (list) +>>>> +>>>>> The tag keys to exclude. All of the alarm’s tags except those with these keys are included. +>>>>> +>>>>> You can specify 1 to 50 tag keys. Each tag key must be 1 to 128 characters long. +>>>>> +>>>>> You can’t specify both `IncludedTagKeys` and `ExcludedTagKeys` . +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `50` +>>>>> + +>>>>> +>>>>> (string) +>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `1` +>>>>>> * max: `128` +>>>>>> + @@ -1694,0 +1819,62 @@ LogAlarms -> (list) +>> +>> ActionConfiguration -> (structure) +>> +>>> Settings that change the content of the notifications and events that the alarm sends when its state changes. These settings apply to the alarm’s actions, whichever state triggers them. +>>> +>>> AlarmTagsPropagation -> (structure) +>>> +>>>> Settings for including the alarm’s tags in its action notifications and state-change events. +>>>> +>>>> Enabled -> (boolean) [required] +>>>> +>>>>> Set to `true` to include the alarm’s tags. Set to `false` to stop including them. +>>>>> +>>>>> When this is `true` , you must have the `cloudwatch:ListTagsForResource` permission on the alarm to create or update it. +>>>> +>>>> IncludedTagKeys -> (list) +>>>> +>>>>> The tag keys to include. Only the alarm’s tags with these keys are included. +>>>>> +>>>>> You can specify 1 to 50 tag keys. Each tag key must be 1 to 128 characters long. +>>>>> +>>>>> You can’t specify both `IncludedTagKeys` and `ExcludedTagKeys` . +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `50` +>>>>> + +>>>>> +>>>>> (string) +>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `1` +>>>>>> * max: `128` +>>>>>> + +>>>> +>>>> ExcludedTagKeys -> (list) +>>>> +>>>>> The tag keys to exclude. All of the alarm’s tags except those with these keys are included. +>>>>> +>>>>> You can specify 1 to 50 tag keys. Each tag key must be 1 to 128 characters long. +>>>>> +>>>>> You can’t specify both `IncludedTagKeys` and `ExcludedTagKeys` . +>>>>> +>>>>> Constraints: +>>>>> +>>>>> * min: `1` +>>>>> * max: `50` +>>>>> + +>>>>> +>>>>> (string) +>>>>> +>>>>>> Constraints: +>>>>>> +>>>>>> * min: `1` +>>>>>> * max: `128` +>>>>>> + @@ -1710 +1896 @@ NextToken -> (string) - * [AWS CLI 2.38.1 Command Reference](../../index.html) » + * [AWS CLI 2.38.2 Command Reference](../../index.html) »