amazonka-ssm-incidents-2.0: Amazon Systems Manager Incident Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SSMIncidents.Types.IncidentTemplate

Description

 
Synopsis

Documentation

data IncidentTemplate Source #

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

Instances details
FromJSON IncidentTemplate Source # 
Instance details

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

ToJSON IncidentTemplate Source # 
Instance details

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Generic IncidentTemplate Source # 
Instance details

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Associated Types

type Rep IncidentTemplate :: Type -> Type #

Read IncidentTemplate Source # 
Instance details

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Show IncidentTemplate Source # 
Instance details

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

NFData IncidentTemplate Source # 
Instance details

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Methods

rnf :: IncidentTemplate -> () #

Eq IncidentTemplate Source # 
Instance details

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

Hashable IncidentTemplate Source # 
Instance details

Defined in Amazonka.SSMIncidents.Types.IncidentTemplate

type Rep IncidentTemplate Source # 
Instance details

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 Source #

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) Source #

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

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

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]) Source #

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

incidentTemplate_summary :: Lens' IncidentTemplate (Maybe Text) Source #

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 Source #

The impact of the incident on your customers and applications.