Package software.amazon.awscdk.services.events

Class EventBus.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<EventBus>

Enclosing class:

EventBus

@Stability(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	Description
EventBus	build()
static EventBus.Builder	create(software.constructs.Construct scope, String id)
EventBus.Builder	deadLetterQueue(IQueue deadLetterQueue)	Dead-letter queue for the event bus.
EventBus.Builder	description(String description)	The event bus description.
EventBus.Builder	eventBusName(String eventBusName)	The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.
EventBus.Builder	eventSourceName(String eventSourceName)	The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.
EventBus.Builder	kmsKey(IKey kmsKey)	The customer managed key that encrypt events on this event bus.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static EventBus.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of EventBus.Builder.

deadLetterQueue

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

Dead-letter queue for the event bus.

Default: - no dead-letter queue

Parameters:

deadLetterQueue - Dead-letter queue for the event bus. This parameter is required.

Returns:

this

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-rule-event-delivery.html#eb-rule-dlq

description

@Stability(Stable)
public EventBus.Builder description(String description)

The event bus description.

The description can be up to 512 characters long.

Default: - no description

Parameters:

description - The event bus description. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html#cfn-events-eventbus-description

eventBusName

@Stability(Stable)
public EventBus.Builder eventBusName(String eventBusName)

The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this.

Default: - automatically generated name

Parameters:

eventBusName - The name of the event bus you are creating Note: If 'eventSourceName' is passed in, you cannot set this. This parameter is required.

Returns:

this

eventSourceName

@Stability(Stable)
public EventBus.Builder eventSourceName(String eventSourceName)

The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this.

Default: - no partner event source

Parameters:

eventSourceName - The partner event source to associate with this event bus resource Note: If 'eventBusName' is passed in, you cannot set this. This parameter is required.

Returns:

this

kmsKey

@Stability(Stable)
public EventBus.Builder kmsKey(IKey kmsKey)

The customer managed key that encrypt events on this event bus.

Default: - Use an AWS managed key

Parameters:

kmsKey - The customer managed key that encrypt events on this event bus. This parameter is required.

Returns:

this

build

@Stability(Stable)
public EventBus build()

Specified by:

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

Returns:

a newly built instance of EventBus.