Amazonka.SSMIncidents.Types.IncidentTemplate

Documentation

data IncidentTemplate

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

See: newIncidentTemplate smart constructor.

Constructors

IncidentTemplate'

Fields

• dedupeString :: Maybe Text

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

• incidentTags :: Maybe (HashMap Text Text)

  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.

• notificationTargets :: Maybe [NotificationTargetItem]

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

• summary :: Maybe Text

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

• impact :: Natural

  The impact of the incident on your customers and applications.

• title :: Text

  The title of the incident.

Instances

FromJSON IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Methods

parseJSON :: Value -> Parser IncidentTemplate

parseJSONList :: Value -> Parser [IncidentTemplate]

ToJSON IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Methods

toJSON :: IncidentTemplate -> Value

toEncoding :: IncidentTemplate -> Encoding

toJSONList :: [IncidentTemplate] -> Value

toEncodingList :: [IncidentTemplate] -> Encoding

Generic IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Associated Types

type Rep IncidentTemplate :: Type -> Type

Methods

from :: IncidentTemplate -> Rep IncidentTemplate x

to :: Rep IncidentTemplate x -> IncidentTemplate

Read IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Methods

readsPrec :: Int -> ReadS IncidentTemplate

readList :: ReadS [IncidentTemplate]

readPrec :: ReadPrec IncidentTemplate

readListPrec :: ReadPrec [IncidentTemplate]

Show IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Methods

showsPrec :: Int -> IncidentTemplate -> ShowS

show :: IncidentTemplate -> String

showList :: [IncidentTemplate] -> ShowS

NFData IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Methods

rnf :: IncidentTemplate -> ()

Eq IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Methods

(==) :: IncidentTemplate -> IncidentTemplate -> Bool

(/=) :: IncidentTemplate -> IncidentTemplate -> Bool

Hashable IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Methods

hashWithSalt :: Int -> IncidentTemplate -> Int

hash :: IncidentTemplate -> Int

type Rep IncidentTemplate

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

type Rep IncidentTemplate = D1 ('MetaData "IncidentTemplate" "Amazonka.SSMIncidents.Types.IncidentTemplate" "amazonka-ssm-incidents-2.0-JEcCJ5TIs2l5vrFa2RYlgd" 'False) (C1 ('MetaCons "IncidentTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dedupeString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "incidentTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "notificationTargets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NotificationTargetItem])))) :*: (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "impact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newIncidentTemplate

Arguments

:: Natural

$sel:impact:IncidentTemplate'

-> Text

$sel:title:IncidentTemplate'

-> IncidentTemplate

Create a value of IncidentTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dedupeString:IncidentTemplate', incidentTemplate_dedupeString - Used to stop Incident Manager from creating multiple incident records for the same incident.

$sel:incidentTags:IncidentTemplate', incidentTemplate_incidentTags - 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.

$sel:notificationTargets:IncidentTemplate', incidentTemplate_notificationTargets - The Amazon SNS targets that are notified when updates are made to an incident.

$sel:summary:IncidentTemplate', incidentTemplate_summary - The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.

$sel:impact:IncidentTemplate', incidentTemplate_impact - The impact of the incident on your customers and applications.

$sel:title:IncidentTemplate', incidentTemplate_title - The title of the incident.

incidentTemplate_dedupeString :: Lens' IncidentTemplate (Maybe Text)

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

incidentTemplate_incidentTags :: Lens' IncidentTemplate (Maybe (HashMap Text Text))

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.

incidentTemplate_notificationTargets :: Lens' IncidentTemplate (Maybe [NotificationTargetItem])

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

incidentTemplate_summary :: Lens' IncidentTemplate (Maybe Text)

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

incidentTemplate_impact :: Lens' IncidentTemplate Natural

The impact of the incident on your customers and applications.

incidentTemplate_title :: Lens' IncidentTemplate Text

The title of the incident.