Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.
See https://www.paws-r-sdk.com/docs/cloudwatch_put_composite_alarm/ for full documentation.
cloudwatch_put_composite_alarm(
ActionsEnabled = NULL,
AlarmActions = NULL,
AlarmDescription = NULL,
AlarmName,
AlarmRule,
InsufficientDataActions = NULL,
OKActions = NULL,
Tags = NULL,
ActionsSuppressor = NULL,
ActionsSuppressorWaitPeriod = NULL,
ActionsSuppressorExtensionPeriod = NULL
)Indicates whether actions should be executed during any changes to the
alarm state of the composite alarm. The default is TRUE.
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: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function:
arn:aws:lambda:region:account-id:function:function-name:alias-name
Systems Manager actions:
arn:aws:ssm:region:account-id:opsitem:severity
Start a Amazon Q Developer operational investigation
arn:aws:aiops:region:account-id:investigation-group:ingestigation-group-id
The description for the composite alarm.
[required] The name for the composite alarm. This name must be unique within the Region.
[required] An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
ALARM("alarm-name or alarm-ARN") is TRUE if the named alarm is in
ALARM state.
OK("alarm-name or alarm-ARN") is TRUE if the named alarm is in OK
state.
INSUFFICIENT_DATA("alarm-name or alarm-ARN") is TRUE if the named
alarm is in INSUFFICIENT_DATA state.
TRUE always evaluates to TRUE.
FALSE always evaluates to FALSE.
TRUE and FALSE are useful for testing a complex AlarmRule structure,
and for testing your alarm actions.
Alarm names specified in AlarmRule can be surrounded with
double-quotes ("), but do not have to be.
The following are some examples of AlarmRule:
ALARM(CPUUtilizationTooHigh) AND ALARM(DiskReadOpsTooHigh)
specifies that the composite alarm goes into ALARM state only if
both CPUUtilizationTooHigh and DiskReadOpsTooHigh alarms are in
ALARM state.
ALARM(CPUUtilizationTooHigh) AND NOT ALARM(DeploymentInProgress)
specifies that the alarm goes to ALARM state if
CPUUtilizationTooHigh is in ALARM state and DeploymentInProgress is
not in ALARM state. This example reduces alarm noise during a known
deployment window.
(ALARM(CPUUtilizationTooHigh) OR ALARM(DiskReadOpsTooHigh)) AND OK(NetworkOutTooHigh)
goes into ALARM state if CPUUtilizationTooHigh OR DiskReadOpsTooHigh
is in ALARM state, and if NetworkOutTooHigh is in OK state. This
provides another example of using a composite alarm to prevent
noise. This rule ensures that you are not notified with an alarm
action on high CPU or disk usage if a known network problem is also
occurring.
The AlarmRule can specify as many as 100 "children" alarms. The
AlarmRule expression can have as many as 500 elements. Elements are
child alarms, TRUE or FALSE statements, and parentheses.
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: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function:
arn:aws:lambda:region:account-id:function:function-name:alias-name
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: ]
Amazon SNS actions:
arn:aws:sns:region:account-id:sns-topic-name
Lambda actions:
Invoke the latest version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name
Invoke a specific version of a Lambda function:
arn:aws:lambda:region:account-id:function:function-name:version-number
Invoke a function by using an alias Lambda function:
arn:aws:lambda:region:account-id:function:function-name:alias-name
A list of key-value pairs to associate with the alarm. You can associate
as many as 50 tags with an alarm. To be able to associate tags with the
alarm when you create the alarm, you must have the
cloudwatch:TagResource permission.
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 tag_resource or
untag_resource.
Actions will be suppressed if the suppressor alarm is in the ALARM
state. ActionsSuppressor can be an AlarmName or an Amazon Resource
Name (ARN) from an existing alarm.
The maximum time in seconds that the composite alarm waits for the
suppressor alarm to go into the ALARM state. After this time, the
composite alarm performs its actions.
WaitPeriod is required only when ActionsSuppressor is specified.
The maximum time in seconds that the composite alarm waits after
suppressor alarm goes out of the ALARM state. After this time, the
composite alarm performs its actions.
ExtensionPeriod is required only when ActionsSuppressor is
specified.