Package software.amazon.awscdk.services.events.targets

Class EventBusProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EventBusProps>

Enclosing interface:

EventBusProps

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

A builder for EventBusProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EventBusProps	build()	Builds the configured instance.
EventBusProps.Builder	deadLetterQueue(IQueue deadLetterQueue)	Sets the value of EventBusProps.getDeadLetterQueue()
EventBusProps.Builder	role(IRole role)	Sets the value of EventBusProps.getRole()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

deadLetterQueue

@Stability(Stable)
public EventBusProps.Builder deadLetterQueue(IQueue deadLetterQueue)

Sets the value of EventBusProps.getDeadLetterQueue()

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue. 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.

Returns:

this

role

@Stability(Stable)
public EventBusProps.Builder role(IRole role)

Sets the value of EventBusProps.getRole()

Parameters:

role - Role to be used to publish the event.

Returns:

this

build

@Stability(Stable)
public EventBusProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of EventBusProps

Throws:

NullPointerException - if any required attribute was not provided