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:
# Example automatically generated from non-compiling source. May contain errors.
from aws_solutions_constructs.aws_eventbridge_sqs import EventbridgeToSqsProps
from aws_cdk.core import Duration
import aws_cdk.aws_events as events
import aws_cdk.aws_iam as iam
from aws_solutions_constructs.aws_eventbridge_sqs import EventbridgeToSqsProps, EventbridgeToSqs
props = EventbridgeToSqsProps(
event_rule_props=events.RuleProps(
schedule=events.Schedule.rate(Duration.minutes(5))
)
)
construct_stack = EventbridgeToSqs(self, "test-construct", props)
# Grant yourself permissions to use the Customer Managed KMS Key
policy_statement = iam.PolicyStatement(
actions=["kms:Encrypt", "kms:Decrypt"],
effect=iam.Effect.ALLOW,
principals=[iam.AccountRootPrincipal()],
resources=["*"]
)
construct_stack.encryption_key.add_to_resource_policy(policy_statement)
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-1.129.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7944e296c6e78267e940e7ea6822e95e9925b5e1bc4cd83e29f9d3a43f40aec9 |
|
MD5 | bed8c1c7702f2d7d3d8dc1834baf0a62 |
|
BLAKE2b-256 | 3d3a7c5c6575ecb12c6a694d93e2a8627dc363d60f5f1abd141a04fbef471bc7 |
Close
Hashes for aws_solutions_constructs.aws_eventbridge_sqs-1.129.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b59615fb632672af7bd33d0917c9872b1e6a523d34c34a80c25ec673732a839c |
|
MD5 | df2f6654a3b24471ca8b9b6974596527 |
|
BLAKE2b-256 | c95433d750e65ae579986e3d3e0cf98e4aefd286eed69b645910dbd90428127e |