eventbridgev2/aws.sdk.kotlin.services.eventbridgev2.model/CreateSubscriberRequest/Builder

Builder

Properties

var batchConfiguration: BatchConfiguration?

Batching configuration for a subscriber.

Unique, case-sensitive identifier that ensures the idempotency of the request. The SDK generates one automatically when the field is omitted.

description

var description: String?

Free-text description. Used by every resource type that has one: event buses, subscribers, and event sources.

eventBusArn

var eventBusArn: String?

The Amazon Resource Name (ARN) that uniquely identifies an event bus.

filterConfiguration

var filterConfiguration: FilterConfiguration?

Configuration for filtering events delivered to a subscriber. On CreateSubscriber, Filters is required and must contain at least one Filter with a non-empty Pattern. On UpdateSubscriber, an empty FilterConfiguration:{} clears the existing filter. Any non-empty shape (including {Language:X} without Filters) must contain a valid Filters list — same contract as CreateSubscriber. A non-empty Filters list overwrites; an omitted FilterConfiguration preserves existing state. All Filters are implicitly ANDed — an event must match every Filter to be delivered.

invokeConfiguration

var invokeConfiguration: InvokeConfiguration?

Configuration for how the subscriber invokes its target.

logConfiguration

var logConfiguration: LogConfiguration?

Log configuration for a subscriber.

name

var name: String?

Name of a subscriber. The first character must be alphanumeric; the remaining characters may also include '.', '-', and '_'.

onFailureConfiguration

var onFailureConfiguration: OnFailureConfiguration?

On-failure configuration: where a failed delivery is sent. Shared by the subscriber and the EventSource.

pointInTimeConfiguration

var pointInTimeConfiguration: PointInTimeConfiguration?

Point-in-time configuration for a subscriber. Only applicable when StartingPosition is POINT_IN_TIME.

retryPolicy

var retryPolicy: RetryPolicy?

Retry policy for a subscriber.

startingPosition

var startingPosition: StartingPosition?

Starting position for a subscriber.

state

var state: SubscriberState?

Customer-controlled run state of a subscriber, set on create or update. Distinct from the bus lifecycle vocabulary, where ACTIVE means "provisioned and healthy". Delivery requires State RUNNING on a subscriber that is not revoked.