IncidentTemplate (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ssmincidents.model.IncidentTemplate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IncidentTemplate
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Basic details used in creating a response plan. The response plan is then used to create an incident record.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IncidentTemplate()

Constructors
Constructor and Description
`IncidentTemplate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IncidentTemplate`	`addIncidentTagsEntry(String key, String value)` Add a single IncidentTags entry
`IncidentTemplate`	`clearIncidentTagsEntries()` Removes all the entries added into IncidentTags.
`IncidentTemplate`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDedupeString()` The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.
`Integer`	`getImpact()` The impact of the incident on your customers and applications.
`Map<String,String>`	`getIncidentTags()` Tags to assign to the template.
`List<NotificationTargetItem>`	`getNotificationTargets()` The Amazon SNS targets that are notified when updates are made to an incident.
`String`	`getSummary()` The summary of the incident.
`String`	`getTitle()` The title of the incident.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDedupeString(String dedupeString)` The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.
`void`	`setImpact(Integer impact)` The impact of the incident on your customers and applications.
`void`	`setIncidentTags(Map<String,String> incidentTags)` Tags to assign to the template.
`void`	`setNotificationTargets(Collection<NotificationTargetItem> notificationTargets)` The Amazon SNS targets that are notified when updates are made to an incident.
`void`	`setSummary(String summary)` The summary of the incident.
`void`	`setTitle(String title)` The title of the incident.
`String`	`toString()` Returns a string representation of this object.
`IncidentTemplate`	`withDedupeString(String dedupeString)` The string Incident Manager uses to prevent the same root cause from creating multiple incidents in the same account.
`IncidentTemplate`	`withImpact(Integer impact)` The impact of the incident on your customers and applications.
`IncidentTemplate`	`withIncidentTags(Map<String,String> incidentTags)` Tags to assign to the template.
`IncidentTemplate`	`withNotificationTargets(Collection<NotificationTargetItem> notificationTargets)` The Amazon SNS targets that are notified when updates are made to an incident.
`IncidentTemplate`	`withNotificationTargets(NotificationTargetItem... notificationTargets)` The Amazon SNS targets that are notified when updates are made to an incident.
`IncidentTemplate`	`withSummary(String summary)` The summary of the incident.
`IncidentTemplate`	`withTitle(String title)` The title of the incident.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IncidentTemplate
```
public IncidentTemplate()
```
- Method Detail
  - setDedupeString
```
public void setDedupeString(String dedupeString)
```
    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.
    
    Parameters:
    
    dedupeString - 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.
  - getDedupeString
```
public String getDedupeString()
```
    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:
    
    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.
  - withDedupeString
```
public IncidentTemplate withDedupeString(String dedupeString)
```
    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.
    
    Parameters:
    
    dedupeString - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImpact
```
public void setImpact(Integer impact)
```
    The impact of the incident on your customers and applications.
    
    Supported impact codes
    - 1 - Critical
    - 2 - High
    - 3 - Medium
    - 4 - Low
    - 5 - No Impact
    Parameters:
    impact - The impact of the incident on your customers and applications.
    
    Supported impact codes
    
    1 - Critical
    
    2 - High
    
    3 - Medium
    
    4 - Low
    
    5 - No Impact
  - getImpact
```
public Integer getImpact()
```
    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:
    The impact of the incident on your customers and applications.
    
    Supported impact codes
    
    1 - Critical
    
    2 - High
    
    3 - Medium
    
    4 - Low
    
    5 - No Impact
  - withImpact
```
public IncidentTemplate withImpact(Integer impact)
```
    The impact of the incident on your customers and applications.
    
    Supported impact codes
    - 1 - Critical
    - 2 - High
    - 3 - Medium
    - 4 - Low
    - 5 - No Impact
    Parameters:
    impact - 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIncidentTags
```
public Map<String,String> 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.
    
    Returns:
    
    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.
  - setIncidentTags
```
public void setIncidentTags(Map<String,String> 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.
    
    Parameters:
    
    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.
  - withIncidentTags
```
public IncidentTemplate withIncidentTags(Map<String,String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addIncidentTagsEntry
```
public IncidentTemplate addIncidentTagsEntry(String key,
                                             String value)
```
    Add a single IncidentTags entry
    
    See Also:
    
    withIncidentTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearIncidentTagsEntries
```
public IncidentTemplate clearIncidentTagsEntries()
```
    Removes all the entries added into IncidentTags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotificationTargets
```
public List<NotificationTargetItem> getNotificationTargets()
```
    The Amazon SNS targets that are notified when updates are made to an incident.
    
    Returns:
    
    The Amazon SNS targets that are notified when updates are made to an incident.
  - setNotificationTargets
```
public void setNotificationTargets(Collection<NotificationTargetItem> notificationTargets)
```
    The Amazon SNS targets that are notified when updates are made to an incident.
    
    Parameters:
    
    notificationTargets - The Amazon SNS targets that are notified when updates are made to an incident.
  - withNotificationTargets
```
public IncidentTemplate withNotificationTargets(NotificationTargetItem... notificationTargets)
```
    The Amazon SNS targets that are notified when updates are made to an incident.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotificationTargets(java.util.Collection) or withNotificationTargets(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    notificationTargets - The Amazon SNS targets that are notified when updates are made to an incident.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNotificationTargets
```
public IncidentTemplate withNotificationTargets(Collection<NotificationTargetItem> notificationTargets)
```
    The Amazon SNS targets that are notified when updates are made to an incident.
    
    Parameters:
    
    notificationTargets - The Amazon SNS targets that are notified when updates are made to an incident.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSummary
```
public void setSummary(String summary)
```
    The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
    
    Parameters:
    
    summary - The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
  - getSummary
```
public String getSummary()
```
    The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
    
    Returns:
    
    The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
  - withSummary
```
public IncidentTemplate withSummary(String summary)
```
    The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
    
    Parameters:
    
    summary - The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(String title)
```
    The title of the incident.
    
    Parameters:
    
    title - The title of the incident.
  - getTitle
```
public String getTitle()
```
    The title of the incident.
    
    Returns:
    
    The title of the incident.
  - withTitle
```
public IncidentTemplate withTitle(String title)
```
    The title of the incident.
    
    Parameters:
    
    title - The title of the incident.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public IncidentTemplate clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.793

Class IncidentTemplate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IncidentTemplate

Method Detail

setDedupeString

getDedupeString

withDedupeString

setImpact

getImpact

withImpact

getIncidentTags

setIncidentTags

withIncidentTags

addIncidentTagsEntry

clearIncidentTagsEntries

getNotificationTargets

setNotificationTargets

withNotificationTargets

withNotificationTargets

setSummary

getSummary

withSummary

setTitle

getTitle

withTitle

toString

equals

hashCode

clone

marshall