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

Interface EventBusProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EventBusProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.066Z")
@Stability(Stable)
public interface EventBusProps
extends software.amazon.jsii.JsiiSerializable

Configuration properties of an Event Bus event.

Cannot extend TargetBaseProps. Retry policy is not supported for Event bus targets.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.events.targets.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 Role role;
 EventBusProps eventBusProps = EventBusProps.builder()
         .deadLetterQueue(queue)
         .role(role)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	EventBusProps.Builder	A builder for EventBusProps
static final class	EventBusProps.Jsii$Proxy	An implementation for EventBusProps

Method Summary

Modifier and Type	Method	Description
static EventBusProps.Builder	builder()
default IQueue	getDeadLetterQueue()	The SQS queue to be used as deadLetterQueue.
default IRole	getRole()	Role to be used to publish the event.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDeadLetterQueue

@Stability(Stable)
@Nullable
default IQueue getDeadLetterQueue()

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.

Default: - no dead-letter queue

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

Role to be used to publish the event.

Default: a new role is created.

builder

@Stability(Stable)
static EventBusProps.Builder builder()

Returns:

a EventBusProps.Builder of EventBusProps