CDK Constructs for deploying AWS Eventbridge that invokes AWS SQS
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for aws-solutions-constructs.aws-eventbridge-sqs-2.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbc09d7d961d4ba4888e1d7e3d8f371f96bdfb28a385033d2a21324cd0501189 |
|
MD5 | 6f40939ae19ad85656e5f1b3c5071604 |
|
BLAKE2b-256 | 3cc0e37befe5d63e81807187af1ca5f0465cad4df156e2b9d2512f2fd4db8ec9 |
Close
Hashes for aws_solutions_constructs.aws_eventbridge_sqs-2.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f07369c4cb9d4330a67c5b16a5a06630e5fe1c87bc162b42956654aa1da5022 |
|
MD5 | 380294f3af01c177566d1f6bda65c1f1 |
|
BLAKE2b-256 | 5b91abaa9ff3bd4ff4ce1e6eeb95995b2378a70a2ee8611a678248c4567dae69 |