aws-cdk-lib.aws_events_targets.SqsQueue

class SqsQueue

LanguageType name
.NETAmazon.CDK.AWS.Events.Targets.SqsQueue
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseventstargets#SqsQueue
Javasoftware.amazon.awscdk.services.events.targets.SqsQueue
Pythonaws_cdk.aws_events_targets.SqsQueue
TypeScript (source)aws-cdk-lib » aws_events_targets » SqsQueue

Implements IRuleTarget

Use an SQS Queue as a target for Amazon EventBridge rules.

Example

  /// fixture=withRepoAndSqsQueue
  // publish to an SQS queue every time code is committed
  // to a CodeCommit repository
  repository.onCommit('onCommit', { target: new targets.SqsQueue(queue) });

Initializer

new SqsQueue(queue: IQueue, props?: SqsQueueProps)

Parameters

  • queue IQueue
  • props SqsQueueProps

Properties

NameTypeDescription
queueIQueue

queue

Type: IQueue

Methods

NameDescription
bind(rule, _id?)Returns a RuleTarget that can be used to trigger this SQS queue as a result from an EventBridge event.

bind(rule, _id?)

public bind(rule: IRule, _id?: string): RuleTargetConfig

Parameters

  • rule IRule
  • _id string

Returns

  • RuleTargetConfig

Returns a RuleTarget that can be used to trigger this SQS queue as a result from an EventBridge event.

See also: https://docs.aws.amazon.com/eventbridge/latest/userguide/resource-based-policies-eventbridge.html#sqs-permissions