software.amazon.awscdk.services.events.targets

Class EventBus.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.EventBus.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<EventBus>

Enclosing class:

EventBus

@Stability(value=Stable)
public static final class EventBus.Builder
extends Object
implements software.amazon.jsii.Builder<EventBus>

A fluent builder for EventBus.

Method Summary

Modifier and Type	Method and Description
EventBus	build()
static EventBus.Builder	create(IEventBus eventBus)
EventBus.Builder	deadLetterQueue(IQueue deadLetterQueue) The SQS queue to be used as deadLetterQueue.
EventBus.Builder	role(IRole role) Role to be used to publish the event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static EventBus.Builder create(IEventBus eventBus)

Parameters:

eventBus - This parameter is required.

Returns:

a new instance of EventBus.Builder.

deadLetterQueue

@Stability(value=Stable)
public EventBus.Builder deadLetterQueue(IQueue deadLetterQueue)

The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations). This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public EventBus.Builder role(IRole role)

Role to be used to publish the event.

Default: a new role is created.

Parameters:

role - Role to be used to publish the event. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public EventBus build()

Specified by:

build in interface software.amazon.jsii.Builder<EventBus>