awssolutionsconstructsawseventbridgesqs

README

aws-eventbridge-sqs module

---

---

Reference Documentation:	https://docs.aws.amazon.com/solutions/latest/constructs/

Language	Package
Python	aws_solutions_constructs.aws_eventbridge_sqs
Typescript	@aws-solutions-constructs/aws-eventbridge-sqs
Java	software.amazon.awsconstructs.services.eventbridgesqs

This AWS Solutions Construct implements an Amazon EventBridge rule and an AWS SQS Queue.

Here is a minimal deployable pattern definition in Typescript:

import { Duration } from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { EventbridgeToSqsProps, EventbridgeToSqs } from "@aws-solutions-constructs/aws-eventbridge-sqs";

const props: EventbridgeToSqsProps = {
  eventRuleProps: {
    schedule: events.Schedule.rate(Duration.minutes(5))
  }
};

const constructStack = new EventbridgeToSqs(this, 'test-construct', props);

// Grant yourself permissions to use the Customer Managed KMS Key
const policyStatement = new iam.PolicyStatement({
  actions: ["kms:Encrypt", "kms:Decrypt"],
  effect: iam.Effect.ALLOW,
  principals: [ new iam.AccountRootPrincipal() ],
  resources: [ "*" ]
});

constructStack.encryptionKey?.addToResourcePolicy(policyStatement);

Initializer

new EventbridgeToSqs(scope: Construct, id: string, props: EventbridgeToSqsProps);

Parameters

• scope Construct
• id string
• props EventbridgeToSqsProps

Pattern Construct Props

Name	Type	Description
existingEventBusInterface?	events.IEventBus	Optional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error.
eventBusProps?	events.EventBusProps	Optional user-provided properties to override the default properties when creating a custom EventBus. Setting this value to {} will create a custom EventBus using all default properties. If neither this nor existingEventBusInterface is provided the construct will use the default EventBus. Providing both this and existingEventBusInterface results an error.
eventRuleProps	events.RuleProps	User provided eventRuleProps to override the defaults.
existingQueueObj?	sqs.Queue	An optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.
queueProps?	sqs.QueueProps	User provided props to override the default props for the SQS Queue.
enableQueuePurging?	boolean	Whether to grant additional permissions to the Lambda function enabling it to purge the SQS queue. Defaults to false.
deployDeadLetterQueue?	boolean	Whether to create a secondary queue to be used as a dead letter queue. Defaults to true.
deadLetterQueueProps?	sqs.QueueProps	Optional user-provided props to override the default props for the dead letter queue. Only used if the deployDeadLetterQueue property is set to true.
maxReceiveCount?	number	The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.
enableEncryptionWithCustomerManagedKey?	boolean	Use a KMS Key, either managed by this CDK app, or imported. If importing an encryption key, it must be specified in the encryptionKey property for this construct.
encryptionKey?	kms.Key	An optional, imported encryption key to encrypt the SQS queue.
encryptionKeyProps?	kms.KeyProps	An optional, user provided properties to override the default properties for the KMS encryption key.

Pattern Properties

Name	Type	Description
eventBus?	events.IEventBus	Returns the instance of events.IEventBus used by the construct
eventsRule	events.Rule	Returns an instance of events.Rule created by the construct
sqsQueue	sqs.Queue	Returns an instance of sqs.Queue created by the construct
encryptionKey?	kms.Key	Returns an instance of kms Key used for the SQS queue.
deadLetterQueue?	sqs.Queue	Returns an instance of the dead-letter SQS queue created by the pattern.

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon EventBridge Rule

• Grant least privilege permissions to EventBridge rule to publish to the SQS Queue.

Amazon SQS Queue

• Deploy SQS dead-letter queue for the source SQS Queue.
• Enable server-side encryption for source SQS Queue using Customer managed KMS Key.
• Enforce encryption of data in transit.

Architecture

---

© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

Documentation

Overview

CDK Constructs for deploying AWS Eventbridge that invokes AWS SQS

Index

• func EventbridgeToSqs_IsConstruct(x interface{}) *bool
• func NewEventbridgeToSqs_Override(e EventbridgeToSqs, scope constructs.Construct, id *string, ...)
• type EventbridgeToSqs
  • func NewEventbridgeToSqs(scope constructs.Construct, id *string, props *EventbridgeToSqsProps) EventbridgeToSqs
• type EventbridgeToSqsProps

Functions

func EventbridgeToSqs_IsConstruct

func EventbridgeToSqs_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewEventbridgeToSqs_Override

func NewEventbridgeToSqs_Override(e EventbridgeToSqs, scope constructs.Construct, id *string, props *EventbridgeToSqsProps)

Types

type EventbridgeToSqs

type EventbridgeToSqs interface {
	constructs.Construct
	DeadLetterQueue() *awssqs.DeadLetterQueue
	EncryptionKey() awskms.IKey
	EventBus() awsevents.IEventBus
	EventsRule() awsevents.Rule
	Node() constructs.Node
	SqsQueue() awssqs.Queue
	ToString() *string
}

func NewEventbridgeToSqs

func NewEventbridgeToSqs(scope constructs.Construct, id *string, props *EventbridgeToSqsProps) EventbridgeToSqs

type EventbridgeToSqsProps

type EventbridgeToSqsProps struct {
	// User provided eventRuleProps to override the defaults.
	EventRuleProps *awsevents.RuleProps `json:"eventRuleProps"`
	// Optional user provided properties for the dead letter queue.
	DeadLetterQueueProps *awssqs.QueueProps `json:"deadLetterQueueProps"`
	// Whether to deploy a secondary queue to be used as a dead letter queue.
	DeployDeadLetterQueue *bool `json:"deployDeadLetterQueue"`
	// Use a KMS Key, either managed by this CDK app, or imported.
	//
	// If importing an encryption key, it must be specified in
	// the encryptionKey property for this construct.
	EnableEncryptionWithCustomerManagedKey *bool `json:"enableEncryptionWithCustomerManagedKey"`
	// Whether to grant additional permissions to the Lambda function enabling it to purge the SQS queue.
	EnableQueuePurging *bool `json:"enableQueuePurging"`
	// An optional, imported encryption key to encrypt the SQS queue, and SNS Topic.
	EncryptionKey awskms.Key `json:"encryptionKey"`
	// Optional user-provided props to override the default props for the encryption key.
	EncryptionKeyProps *awskms.KeyProps `json:"encryptionKeyProps"`
	// A new custom EventBus is created with provided props.
	EventBusProps *awsevents.EventBusProps `json:"eventBusProps"`
	// Existing instance of a custom EventBus.
	ExistingEventBusInterface awsevents.IEventBus `json:"existingEventBusInterface"`
	// Existing instance of SQS queue object, providing both this and queueProps will cause an error.
	ExistingQueueObj awssqs.Queue `json:"existingQueueObj"`
	// The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
	MaxReceiveCount *float64 `json:"maxReceiveCount"`
	// User provided props to override the default props for the SQS queue.
	QueueProps *awssqs.QueueProps `json:"queueProps"`
}