Interface IncidentRecord.Builder

  • Method Details

    • arn

      The Amazon Resource Name (ARN) of the incident record.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the incident record.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • automationExecutions

      IncidentRecord.Builder automationExecutions(Collection<AutomationExecution> automationExecutions)

      The runbook, or automation document, that's run at the beginning of the incident.

      Parameters:
      automationExecutions - The runbook, or automation document, that's run at the beginning of the incident.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • automationExecutions

      IncidentRecord.Builder automationExecutions(AutomationExecution... automationExecutions)

      The runbook, or automation document, that's run at the beginning of the incident.

      Parameters:
      automationExecutions - The runbook, or automation document, that's run at the beginning of the incident.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • automationExecutions

      IncidentRecord.Builder automationExecutions(Consumer<AutomationExecution.Builder>... automationExecutions)

      The runbook, or automation document, that's run at the beginning of the incident.

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

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

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

      IncidentRecord.Builder chatChannel(ChatChannel chatChannel)

      The chat channel used for collaboration during an incident.

      Parameters:
      chatChannel - The chat channel used for collaboration during an incident.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • chatChannel

      default IncidentRecord.Builder chatChannel(Consumer<ChatChannel.Builder> chatChannel)

      The chat channel used for collaboration during an incident.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to chatChannel(ChatChannel).

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

      IncidentRecord.Builder creationTime(Instant creationTime)

      The timestamp for when Incident Manager created the incident record.

      Parameters:
      creationTime - The timestamp for when Incident Manager created the incident record.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • dedupeString

      IncidentRecord.Builder dedupeString(String dedupeString)

      The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.

      Parameters:
      dedupeString - The string Incident Manager uses to prevent duplicate incidents from being created by the same incident in the same account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • impact

      The impact of the incident on 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 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.
    • incidentRecordSource

      IncidentRecord.Builder incidentRecordSource(IncidentRecordSource incidentRecordSource)

      Details about the action that started the incident.

      Parameters:
      incidentRecordSource - Details about the action that started the incident.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • incidentRecordSource

      default IncidentRecord.Builder incidentRecordSource(Consumer<IncidentRecordSource.Builder> incidentRecordSource)

      Details about the action that started the incident.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to incidentRecordSource(IncidentRecordSource).

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

      IncidentRecord.Builder lastModifiedBy(String lastModifiedBy)

      Who modified the incident most recently.

      Parameters:
      lastModifiedBy - Who modified the incident most recently.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • lastModifiedTime

      IncidentRecord.Builder lastModifiedTime(Instant lastModifiedTime)

      The timestamp for when the incident was most recently modified.

      Parameters:
      lastModifiedTime - The timestamp for when the incident was most recently modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • notificationTargets

      IncidentRecord.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

      IncidentRecord.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

      IncidentRecord.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:
    • resolvedTime

      IncidentRecord.Builder resolvedTime(Instant resolvedTime)

      The timestamp for when the incident was resolved. This appears as a timeline event.

      Parameters:
      resolvedTime - The timestamp for when the incident was resolved. This appears as a timeline event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The current status of the incident.

      Parameters:
      status - The current status of the incident.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The current status of the incident.

      Parameters:
      status - The current status of the incident.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • summary

      IncidentRecord.Builder summary(String summary)

      The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.

      Parameters:
      summary - The summary of the incident. The summary is a brief synopsis of what occurred, what's currently happening, and context of the incident.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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.