Class: Aws::SSMIncidents::Types::IncidentTemplate

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

Overview

Basic details used in creating a response plan. The response plan is then used to create an incident record.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dedupe_string ⇒ String

The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.

A deduplication string is a term or phrase the system uses to check for duplicate incidents. If you specify a deduplication string, Incident Manager searches for open incidents that contain the same string in the dedupeString field when it creates the incident. If a duplicate is detected, Incident Manager deduplicates the newer incident into the existing incident.

By default, Incident Manager automatically deduplicates multiple incidents created by the same Amazon CloudWatch alarm or Amazon EventBridge event. You don't have to enter your own deduplication string to prevent duplication for these resource types.

Returns:

  • (String) 


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1264

class IncidentTemplate < Struct.new(
  :dedupe_string,
  :impact,
  :incident_tags,
  :notification_targets,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#impact ⇒ Integer

The impact of the incident on your customers and applications.

Supported impact codes

  • 1 - Critical

  • 2 - High

  • 3 - Medium

  • 4 - Low

  • 5 - No Impact

Returns:

  • (Integer) 


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1264

class IncidentTemplate < Struct.new(
  :dedupe_string,
  :impact,
  :incident_tags,
  :notification_targets,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#incident_tags ⇒ Hash<String,String>

Tags to assign to the template. When the StartIncident API action is called, Incident Manager assigns the tags specified in the template to the incident.

Returns:

  • (Hash<String,String>) 


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1264

class IncidentTemplate < Struct.new(
  :dedupe_string,
  :impact,
  :incident_tags,
  :notification_targets,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#notification_targets ⇒ Array<Types::NotificationTargetItem>

The Amazon SNS targets that are notified when updates are made to an incident.

Returns:



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1264

class IncidentTemplate < Struct.new(
  :dedupe_string,
  :impact,
  :incident_tags,
  :notification_targets,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#summary ⇒ String

The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.

Returns:

  • (String) 


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1264

class IncidentTemplate < Struct.new(
  :dedupe_string,
  :impact,
  :incident_tags,
  :notification_targets,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the incident.

Returns:

  • (String) 


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1264

class IncidentTemplate < Struct.new(
  :dedupe_string,
  :impact,
  :incident_tags,
  :notification_targets,
  :summary,
  :title)
  SENSITIVE = []
  include Aws::Structure
end