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

Interface UpdateTimelineEventRequest.Builder

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

  • Method Details

    • clientToken

      UpdateTimelineEventRequest.Builder clientToken(String clientToken)

      A token that ensures that a client calls the operation only once with the specified details.

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

    • eventData

      UpdateTimelineEventRequest.Builder eventData(String eventData)

      A short description of the event.

      Parameters:
      eventData - A short description of the event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventId

      UpdateTimelineEventRequest.Builder eventId(String eventId)

      The ID of the event to update. You can use ListTimelineEvents to find an event's ID.

      Parameters:
      eventId - The ID of the event to update. You can use ListTimelineEvents to find an event's ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventReferences

      UpdateTimelineEventRequest.Builder eventReferences(Collection<EventReference> eventReferences)

      Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

      This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

      Parameters:
      eventReferences - Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

      This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

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

    • eventReferences

      UpdateTimelineEventRequest.Builder eventReferences(EventReference... eventReferences)

      Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

      This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

      Parameters:
      eventReferences - Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

      This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

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

    • eventReferences

      UpdateTimelineEventRequest.Builder eventReferences(Consumer<EventReference.Builder>... eventReferences)

      Updates all existing references in a TimelineEvent. A reference is an Amazon Web Services resource involved or associated with the incident. To specify a reference, enter its Amazon Resource Name (ARN). You can also specify a related item associated with that resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use its ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

      This update action overrides all existing references. If you want to keep existing references, you must specify them in the call. If you don't, this action removes any existing references and enters only new references.

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

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

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

    • eventTime

      UpdateTimelineEventRequest.Builder eventTime(Instant eventTime)

      The timestamp for when the event occurred.

      Parameters:
      eventTime - The timestamp for when the event occurred.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventType

      UpdateTimelineEventRequest.Builder eventType(String eventType)

      The type of event. You can update events of type Custom Event and Note.

      Parameters:
      eventType - The type of event. You can update events of type Custom Event and Note.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • incidentRecordArn

      UpdateTimelineEventRequest.Builder incidentRecordArn(String incidentRecordArn)

      The Amazon Resource Name (ARN) of the incident that includes the timeline event.

      Parameters:
      incidentRecordArn - The Amazon Resource Name (ARN) of the incident that includes the timeline event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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