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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb

Overview

Note:

When making an API call, you may pass AlarmConfiguration data as a hash:

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

Information about alarms associated with the deployment group.

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:



105
106
107
108
109
110
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 105

class AlarmConfiguration < Struct.new(
  :enabled,
  :ignore_poll_alarm_failure,
  :alarms)
  include Aws::Structure
end

#enabledBoolean

Indicates whether the alarm configuration is enabled.

Returns:

  • (Boolean)


105
106
107
108
109
110
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 105

class AlarmConfiguration < Struct.new(
  :enabled,
  :ignore_poll_alarm_failure,
  :alarms)
  include Aws::Structure
end

#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)


105
106
107
108
109
110
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 105

class AlarmConfiguration < Struct.new(
  :enabled,
  :ignore_poll_alarm_failure,
  :alarms)
  include Aws::Structure
end