You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeDeploy::Types::AlarmConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AlarmConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  enabled: false,
  ignore_poll_alarm_failure: false,
  alarms: [
    {
      name: "AlarmName",
    },
  ],
}

Information about alarms associated with the deployment group.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#alarmsArray<Types::Alarm>

A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.

Returns:

  • (Array<Types::Alarm>)

    A list of alarms configured for the deployment group.

#enabledBoolean

Indicates whether the alarm configuration is enabled.

Returns:

  • (Boolean)

    Indicates whether the alarm configuration is enabled.

#ignore_poll_alarm_failureBoolean

Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

  • true: The deployment will proceed even if alarm status information can\'t be retrieved from Amazon CloudWatch.

  • false: The deployment will stop if alarm status information can\'t be retrieved from Amazon CloudWatch.

Returns:

  • (Boolean)

    Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch.