Class: Aws::CloudWatchOmni::Types::Alert

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

Overview

Full alert entity, returned by both CreateAlert and GetAlert. A create and a read of the same alert describe it identically except for state, which only the read paths populate. UpdateAlert returns an empty response.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#account_id ⇒ String

The AWS account ID that owns the alert.

Returns:

  • (String) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#alert_arn ⇒ String

The Amazon Resource Name (ARN) of the alert.

Returns:

  • (String) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#alert_id ⇒ String

The stable alert identifier (see AlertId), minted on create and immutable across updates. Use it (not name) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.

Returns:

  • (String) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The timestamp when the alert was created.

Returns:

  • (Time) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

An optional description of the alert.

Returns:

  • (String) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the alert.

Returns:

  • (String) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#notification_rules ⇒ Array<Types::NotificationRule>

The notification rules for the alert.

Returns:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#notification_status ⇒ String

Whether notifications are enabled.

Returns:

  • (String) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#profile_id ⇒ String

The ID of the access profile associated with the alert.

Returns:

  • (String) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#rule ⇒ Types::Rule

The rule that defines how the alert is evaluated.

Returns:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#space_id ⇒ String

The ID of the space the alert belongs to.

Returns:

  • (String) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ Types::AlertStateInfo

Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts reports state on AlertSummary instead, where it stays required.

Absent on CreateAlert: a newly created alert has never been evaluated, so any state reported there would be a default rather than an observation. Call GetAlert for live state. Not @required for that reason — GetAlert always populates it.

contributorSummary is nested inside this member, so it too is absent on CreateAlert.

Returns:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The timestamp when the alert was last updated.

Returns:

  • (Time) 


365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 365

class Alert < Struct.new(
  :name,
  :alert_id,
  :description,
  :account_id,
  :space_id,
  :profile_id,
  :rule,
  :notification_status,
  :state,
  :notification_rules,
  :created_at,
  :updated_at,
  :alert_arn)
  SENSITIVE = []
  include Aws::Structure
end