AwsEventbridgeEventRuleSqsTargetArgs

interface AwsEventbridgeEventRuleSqsTargetArgs extends EventbridgeEventRuleTargetCommon { deadLetterConfig?: NonNullable<Input<EventTargetDeadLetterConfig | undefined>>; eventBus?: undefined; input?: Input<string>; inputPath?: Input<string>; inputTransformer?: NonNullable<Input<EventTargetInputTransformer | undefined>>; lambda?: undefined; logGroup?: undefined; retryPolicy?: NonNullable<Input<EventTargetRetryPolicy | undefined>>; sfn?: undefined; sns?: undefined; sqs: Input<string>; sqsTarget?: NonNullable<Input<EventTargetSqsTarget | undefined>>; }

Target configuration for routing events to an SQS queue.

Example

CODE
const rule = new AwsEventbridgeEventRule({
  name: 'notify',
  defaultEventBus,
  eventPattern: JSON.stringify({ source: ['myapp'] }),
  targets: { queue: { sqs: myQueue.arn } },
});

Hierarchy

  • EventbridgeEventRuleTargetCommon
  • AwsEventbridgeEventRuleSqsTargetArgs

Properties

deadLetterConfig: NonNullable<Input<EventTargetDeadLetterConfig | undefined>>

Inherited from deadLetterConfig

Dead-letter queue configuration for undeliverable events.

eventBus: undefined

input: Input<string>

Inherited from input

Verbatim JSON text passed to the target. Conflicts with inputPath and inputTransformer.

inputPath: Input<string>

Inherited from inputPath

JSONPath expression to extract part of the matched event. Conflicts with input and inputTransformer.

inputTransformer: NonNullable<Input<EventTargetInputTransformer | undefined>>

Inherited from inputTransformer

Custom input transformation applied before delivering the event. Conflicts with input and inputPath.

lambda: undefined

logGroup: undefined

retryPolicy: NonNullable<Input<EventTargetRetryPolicy | undefined>>

Inherited from retryPolicy

Retry policy for failed target invocations.

sfn: undefined

sns: undefined

sqs: Input<string>

ARN or name of the SQS queue. Accepts a full queue ARN or a queue name; names are resolved to ARNs automatically.

sqsTarget: NonNullable<Input<EventTargetSqsTarget | undefined>>

SQS-specific target parameters.

Remarks

Required for FIFO queues to specify a message group ID.