NAME

Paws::CloudWatch::PutCompositeAlarm - Arguments for method PutCompositeAlarm on Paws::CloudWatch

DESCRIPTION

This class represents the parameters used for calling the method PutCompositeAlarm on the Amazon CloudWatch service. Use the attributes of this class as arguments to method PutCompositeAlarm.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutCompositeAlarm.

SYNOPSIS

    my $monitoring = Paws->service('CloudWatch');
    $monitoring->PutCompositeAlarm(
      AlarmName      => 'MyAlarmName',
      AlarmRule      => 'MyAlarmRule',
      ActionsEnabled => 1,               # OPTIONAL
      AlarmActions   => [
        'MyResourceName', ...            # min: 1, max: 1024
      ],    # OPTIONAL
      AlarmDescription        => 'MyAlarmDescription',    # OPTIONAL
      InsufficientDataActions => [
        'MyResourceName', ...                             # min: 1, max: 1024
      ],    # OPTIONAL
      OKActions => [
        'MyResourceName', ...    # min: 1, max: 1024
      ],    # OPTIONAL
      Tags => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128
          Value => 'MyTagValue',    # max: 256

        },
        ...
      ],    # OPTIONAL
    );

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/monitoring/PutCompositeAlarm

ATTRIBUTES

ActionsEnabled => Bool

Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. The default is TRUE.

AlarmActions => ArrayRef[Str|Undef]

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: arn:aws:sns:region:account-id:sns-topic-name | arn:aws:ssm:region:account-id:opsitem:severity

AlarmDescription => Str

The description for the composite alarm.

REQUIRED AlarmName => Str

The name for the composite alarm. This name must be unique within the Region.

REQUIRED AlarmRule => Str

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.

InsufficientDataActions => ArrayRef[Str|Undef]

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: arn:aws:sns:region:account-id:sns-topic-name

OKActions => ArrayRef[Str|Undef]

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: arn:aws:sns:region:account-id:sns-topic-name

Tags => ArrayRef[Paws::CloudWatch::Tag]

A list of key-value pairs to associate with the composite 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method PutCompositeAlarm in Paws::CloudWatch

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

cpanm Paws

perl -MCPAN -e shell
install Paws