Package software.amazon.awssdk.services.ssmincidents.model

Interface IncidentTemplate.Builder

All Superinterfaces:
Buildable, CopyableBuilder<IncidentTemplate.Builder,IncidentTemplate>, SdkBuilder<IncidentTemplate.Builder,IncidentTemplate>, SdkPojo
Enclosing class:
IncidentTemplate
public static interface IncidentTemplate.Builder extends SdkPojo, CopyableBuilder<IncidentTemplate.Builder,IncidentTemplate>

  • Method Details

    • dedupeString

      IncidentTemplate.Builder dedupeString(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.

    • impact

      IncidentTemplate.Builder impact(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.

    • incidentTags

      IncidentTemplate.Builder incidentTags(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.

    • notificationTargets

      IncidentTemplate.Builder notificationTargets(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.

    • notificationTargets

      IncidentTemplate.Builder notificationTargets(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.

    • notificationTargets

      IncidentTemplate.Builder notificationTargets(Consumer<NotificationTargetItem.Builder>... notificationTargets)

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

      This is a convenience method that creates an instance of the NotificationTargetItem.Builder avoiding the need to create one manually via NotificationTargetItem.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationTargets(List<NotificationTargetItem>).

      Parameters:
      notificationTargets - a consumer that will call methods on NotificationTargetItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • summary

      IncidentTemplate.Builder summary(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.

    • title

      IncidentTemplate.Builder title(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.