Class: Aws::CloudWatchOmni::Types::CreateAlertInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

Idempotency token for safe retries. Retrying with the same token within the idempotency window returns the original alert instead of creating a duplicate.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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

#description ⇒ String

An optional description of the alert.

Returns:

  • (String) 


891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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

#name ⇒ String

Alert name, for display. Max 256 (the AlarmName budget). Not the alert's identity: the backend mints a separate uuid as the AlertId, so the name need not be unique within a space and addressing an alert never depends on it. UpdateAlert accepts a new name to rename the alert.

Returns:

  • (String) 


891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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

#notification_rules ⇒ Array<Types::NotificationRule>

The notification rules that determine when and where notifications are sent.

Returns:



891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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

#notifications_enabled ⇒ Boolean

Whether actions (notifications) are enabled for this alert. Defaults to true when omitted.

Returns:

  • (Boolean) 


891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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

#profile_id ⇒ String

The ID of the access profile the alert uses to evaluate its query and execute notifications. The caller supplies it: there is no managed alert profile, and the service does not pick one on the caller's behalf.

Returns:

  • (String) 


891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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

#rule ⇒ Types::Rule

The rule that defines how the alert is evaluated.

Returns:



891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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

#space_id ⇒ String

The unique ID of the space to create the alert in.

Returns:

  • (String) 


891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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

#tags ⇒ Hash<String,String>

The tags to associate with the alert.

Returns:

  • (Hash<String,String>) 


891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'gems/aws-sdk-cloudwatchomni/lib/aws-sdk-cloudwatchomni/types.rb', line 891

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