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

Interface StartIncidentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartIncidentRequest.Builder,StartIncidentRequest>, SdkBuilder<StartIncidentRequest.Builder,StartIncidentRequest>, SdkPojo, SdkRequest.Builder, SsmIncidentsRequest.Builder
Enclosing class:
StartIncidentRequest
public static interface StartIncidentRequest.Builder extends SsmIncidentsRequest.Builder, SdkPojo, CopyableBuilder<StartIncidentRequest.Builder,StartIncidentRequest>

  • Method Details

    • clientToken

      StartIncidentRequest.Builder clientToken(String clientToken)

      A token ensuring that the operation is called only once with the specified details.

      Parameters:
      clientToken - A token ensuring that the operation is called only once with the specified details.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • impact

      StartIncidentRequest.Builder impact(Integer impact)

      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.

      Parameters:
      impact - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedItems

      StartIncidentRequest.Builder relatedItems(Collection<RelatedItem> relatedItems)

      Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

      Parameters:
      relatedItems - Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedItems

      StartIncidentRequest.Builder relatedItems(RelatedItem... relatedItems)

      Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

      Parameters:
      relatedItems - Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • relatedItems

      StartIncidentRequest.Builder relatedItems(Consumer<RelatedItem.Builder>... relatedItems)

      Add related items to the incident for other responders to use. Related items are Amazon Web Services resources, external links, or files uploaded to an Amazon S3 bucket.

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

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

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

    • responsePlanArn

      StartIncidentRequest.Builder responsePlanArn(String responsePlanArn)

      The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.

      Parameters:
      responsePlanArn - The Amazon Resource Name (ARN) of the response plan that pre-defines summary, chat channels, Amazon SNS topics, runbooks, title, and impact of the incident.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      StartIncidentRequest.Builder title(String title)

      Provide a title for the incident. Providing a title overwrites the title provided by the response plan.

      Parameters:
      title - Provide a title for the incident. Providing a title overwrites the title provided by the response plan.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerDetails

      StartIncidentRequest.Builder triggerDetails(TriggerDetails triggerDetails)

      Details of what created the incident record in Incident Manager.

      Parameters:
      triggerDetails - Details of what created the incident record in Incident Manager.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • triggerDetails

      default StartIncidentRequest.Builder triggerDetails(Consumer<TriggerDetails.Builder> triggerDetails)

      Details of what created the incident record in Incident Manager.

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

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

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

    • overrideConfiguration

      StartIncidentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartIncidentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.