Interface EventBusProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
EventBusProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-30T02:11:07.727Z") @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();
 
  • 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