Class IncidentTemplate

java.lang.Object
software.amazon.awssdk.services.ssmincidents.model.IncidentTemplate
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IncidentTemplate.Builder,IncidentTemplate>
@Generated("software.amazon.awssdk:codegen") public final class IncidentTemplate extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IncidentTemplate.Builder,IncidentTemplate>

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

See Also:

  • Method Details

    • dedupeString

      public final 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.

      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.

    • impact

      public final 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

      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

    • hasIncidentTags

      public final boolean hasIncidentTags()
      For responses, this returns true if the service returned a value for the IncidentTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • incidentTags

      public final 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncidentTags() method.

      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.

    • hasNotificationTargets

      public final boolean hasNotificationTargets()
      For responses, this returns true if the service returned a value for the NotificationTargets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • notificationTargets

      public final List<NotificationTargetItem> notificationTargets()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotificationTargets() method.

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

    • summary

      public final String summary()

      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.

    • title

      public final String title()

      The title of the incident.

      Returns:
      The title of the incident.

    • toBuilder

      public IncidentTemplate.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IncidentTemplate.Builder,IncidentTemplate>
      Returns:
      a builder for type T

    • builder

      public static IncidentTemplate.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IncidentTemplate.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.