Interface CfnResponsePlan.IncidentTemplateProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnResponsePlan.IncidentTemplateProperty.Jsii$Proxy
- Enclosing class:
CfnResponsePlan
@Stability(Stable)
public static interface CfnResponsePlan.IncidentTemplateProperty
extends software.amazon.jsii.JsiiSerializable
The
IncidentTemplate
property type specifies details used to create an incident when using this response plan.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ssmincidents.*; IncidentTemplateProperty incidentTemplateProperty = IncidentTemplateProperty.builder() .impact(123) .title("title") // the properties below are optional .dedupeString("dedupeString") .incidentTags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .notificationTargets(List.of(NotificationTargetItemProperty.builder() .snsTopicArn("snsTopicArn") .build())) .summary("summary") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnResponsePlan.IncidentTemplateProperty
static final class
An implementation forCfnResponsePlan.IncidentTemplateProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
Used to create only one incident record for an incident.Defines the impact to the customers.default Object
Tags to assign to the template.default Object
The Amazon Simple Notification Service ( Amazon SNS ) targets that AWS Chatbot uses to notify the chat channel of updates to an incident.default String
The summary describes what has happened during the incident.getTitle()
The title of the incident is a brief and easily recognizable.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getImpact
Defines the impact to the customers. Providing an impact overwrites the impact provided by a response plan.Possible impacts: -
1
- Critical impact, this typically relates to full application failure that impacts many to all customers.2
- High impact, partial application failure with impact to many customers.3
- Medium impact, the application is providing reduced service to customers.4
- Low impact, customer might aren't impacted by the problem yet.5
- No impact, customers aren't currently impacted but urgent action is needed to avoid impact.
- See Also:
-
getTitle
The title of the incident is a brief and easily recognizable.- See Also:
-
getDedupeString
Used to create only one incident record for an incident.- See Also:
-
getIncidentTags
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.- See Also:
-
getNotificationTargets
The Amazon Simple Notification Service ( Amazon SNS ) targets that AWS Chatbot uses to notify the chat channel of updates to an incident.You can also make updates to the incident through the chat channel using the Amazon SNS topics.
- See Also:
-
getSummary
The summary describes what has happened during the incident.- See Also:
-
builder
-