Class: Aws::CloudWatchOmni::Types::UpdateAlertInput

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchOmni::Types::UpdateAlertInput

Defined in:

gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #alert_id ⇒ String

  The alert to update.

• #description ⇒ String

  A new description of the alert.

• #name ⇒ String

  A new display name for the alert.

• #notification_rules ⇒ Array<Types::NotificationRule>

  Replaces the entire notification rule list when present; full-replace, not merge.

• #notifications_enabled ⇒ Boolean

  Whether actions (notifications) are enabled for this alert.

• #profile_id ⇒ String

  The ID of the access profile associated with the alert.

• #rule ⇒ Types::Rule

  The rule that defines how the alert is evaluated.

• #space_id ⇒ String

  The unique ID of the space.

Instance Attribute Details

#alert_id ⇒ String

The alert to update.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4900

class UpdateAlertInput < Struct.new(
  :space_id,
  :alert_id,
  :profile_id,
  :name,
  :description,
  :rule,
  :notifications_enabled,
  :notification_rules)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A new description of the alert. Omit to leave unchanged.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4900

class UpdateAlertInput < Struct.new(
  :space_id,
  :alert_id,
  :profile_id,
  :name,
  :description,
  :rule,
  :notifications_enabled,
  :notification_rules)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A new display name for the alert. Omit to leave the name unchanged (apply-if-present / PATCH). Same constraints as CreateAlert.name; the name is not the alert's identity, so a rename never changes the alertId.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4900

class UpdateAlertInput < Struct.new(
  :space_id,
  :alert_id,
  :profile_id,
  :name,
  :description,
  :rule,
  :notifications_enabled,
  :notification_rules)
  SENSITIVE = []
  include Aws::Structure
end

#notification_rules ⇒ Array<Types::NotificationRule>

Replaces the entire notification rule list when present; full-replace, not merge. Omitted = leave existing rules unchanged. An empty list clears all rules (the alert keeps evaluating; only notifications stop).

Returns:

• (Array<Types::NotificationRule>)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4900

class UpdateAlertInput < Struct.new(
  :space_id,
  :alert_id,
  :profile_id,
  :name,
  :description,
  :rule,
  :notifications_enabled,
  :notification_rules)
  SENSITIVE = []
  include Aws::Structure
end

#notifications_enabled ⇒ Boolean

Whether actions (notifications) are enabled for this alert. Omitted = leave existing value unchanged.

Returns:

• (Boolean)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4900

class UpdateAlertInput < Struct.new(
  :space_id,
  :alert_id,
  :profile_id,
  :name,
  :description,
  :rule,
  :notifications_enabled,
  :notification_rules)
  SENSITIVE = []
  include Aws::Structure
end

#profile_id ⇒ String

The ID of the access profile associated with the alert.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4900

class UpdateAlertInput < Struct.new(
  :space_id,
  :alert_id,
  :profile_id,
  :name,
  :description,
  :rule,
  :notifications_enabled,
  :notification_rules)
  SENSITIVE = []
  include Aws::Structure
end

#rule ⇒ Types::Rule

The rule that defines how the alert is evaluated. Omit to leave unchanged. Each sub-block is replaced whole when present: query, condition, evaluation and noData are applied only when supplied, and within a supplied block an omitted optional member is cleared to unset (null/absent) rather than preserved from the stored alert or defaulted. See AlertCondition and AlertEvaluation.

Returns:

• (Types::Rule)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4900

class UpdateAlertInput < Struct.new(
  :space_id,
  :alert_id,
  :profile_id,
  :name,
  :description,
  :rule,
  :notifications_enabled,
  :notification_rules)
  SENSITIVE = []
  include Aws::Structure
end

#space_id ⇒ String

The unique ID of the space.

Returns:

• (String)

# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 4900

class UpdateAlertInput < Struct.new(
  :space_id,
  :alert_id,
  :profile_id,
  :name,
  :description,
  :rule,
  :notifications_enabled,
  :notification_rules)
  SENSITIVE = []
  include Aws::Structure
end