Interface CreateTimelineEventRequest.Builder

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

  • Method Details

    • clientToken

      CreateTimelineEventRequest.Builder clientToken(String clientToken)

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

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

    • eventData

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

    • eventReferences

      CreateTimelineEventRequest.Builder eventReferences(Collection<EventReference> eventReferences)

      Adds one or more references to the 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 a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

      Parameters:
      eventReferences - Adds one or more references to the 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 a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventReferences

      CreateTimelineEventRequest.Builder eventReferences(EventReference... eventReferences)

      Adds one or more references to the 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 a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

      Parameters:
      eventReferences - Adds one or more references to the 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 a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventReferences

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

      Adds one or more references to the 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 a resource. For example, to specify an Amazon DynamoDB (DynamoDB) table as a resource, use the table's ARN. You can also specify an Amazon CloudWatch metric associated with the DynamoDB table as a related item.

      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

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

      CreateTimelineEventRequest.Builder eventType(String eventType)

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

      To make a Note-type event appear on the Incident notes panel in the console, specify eventType as Noteand enter the Amazon Resource Name (ARN) of the incident as the value for eventReference.

      Parameters:
      eventType - The type of event. You can create timeline events of type Custom Event and Note.

      To make a Note-type event appear on the Incident notes panel in the console, specify eventType as Noteand enter the Amazon Resource Name (ARN) of the incident as the value for eventReference.

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

    • incidentRecordArn

      CreateTimelineEventRequest.Builder incidentRecordArn(String incidentRecordArn)

      The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.

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

    • overrideConfiguration

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

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