software.amazon.awssdk.services.ssmincidents.model

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 Summary

Modifier and Type	Method and Description
CreateTimelineEventRequest.Builder	clientToken(String clientToken) A token that ensures that a client calls the action only once with the specified details.
CreateTimelineEventRequest.Builder	eventData(String eventData) A short description of the event.
CreateTimelineEventRequest.Builder	eventReferences(Collection<EventReference> eventReferences) Adds one or more references to the TimelineEvent.
CreateTimelineEventRequest.Builder	eventReferences(Consumer<EventReference.Builder>... eventReferences) Adds one or more references to the TimelineEvent.
CreateTimelineEventRequest.Builder	eventReferences(EventReference... eventReferences) Adds one or more references to the TimelineEvent.
CreateTimelineEventRequest.Builder	eventTime(Instant eventTime) The time that the event occurred.
CreateTimelineEventRequest.Builder	eventType(String eventType) The type of event.
CreateTimelineEventRequest.Builder	incidentRecordArn(String incidentRecordArn) The Amazon Resource Name (ARN) of the incident record that the action adds the incident to.
CreateTimelineEventRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateTimelineEventRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.ssmincidents.model.SsmIncidentsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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

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:

#eventReferences(java.util.Collection)

eventTime

CreateTimelineEventRequest.Builder eventTime(Instant eventTime)

The time that the event occurred.

Parameters:

eventTime - The time that 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.

Parameters:

eventType - The type of event. You can create timeline events of type Custom Event.

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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateTimelineEventRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder