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

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

Overview

Note:

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

{
  dedupe_string: "DedupeString",
  impact: 1, # required
  notification_targets: [
    {
      sns_topic_arn: "Arn",
    },
  ],
  summary: "IncidentSummary",
  title: "IncidentTitle", # required
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dedupe_stringString

Used to stop Incident Manager from creating multiple incident records for the same incident.

Returns:

  • (String)


1094
1095
1096
1097
1098
1099
1100
1101
1102
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1094

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

#impactInteger

The impact of the incident on your customers and applications.

Returns:

  • (Integer)


1094
1095
1096
1097
1098
1099
1100
1101
1102
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1094

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

#notification_targetsArray<Types::NotificationTargetItem>

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

Returns:



1094
1095
1096
1097
1098
1099
1100
1101
1102
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1094

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

#summaryString

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

Returns:

  • (String)


1094
1095
1096
1097
1098
1099
1100
1101
1102
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1094

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

#titleString

The title of the incident.

Returns:

  • (String)


1094
1095
1096
1097
1098
1099
1100
1101
1102
# File 'gems/aws-sdk-ssmincidents/lib/aws-sdk-ssmincidents/types.rb', line 1094

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