CDK Constructs for deploying AWS Events Rule that invokes AWS SNS
Project description
aws-eventbridge-sns module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_eventbridge_sns |
Typescript | @aws-solutions-constructs/aws-eventbridge-sns |
Java | software.amazon.awsconstructs.services.eventbridgesns |
This AWS Solutions Construct implements an AWS Events rule and an AWS SNS Topic.
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_sns import EventbridgeToSnsProps
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_sns import EventbridgeToSnsProps, EventbridgeToSns
props = EventbridgeToSnsProps(
event_rule_props=events.RuleProps(
schedule=events.Schedule.rate(Duration.minutes(5))
)
)
construct_stack = EventbridgeToSns(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 EventbridgeToSns(scope: Construct, id: string, props: EventbridgeToSnsProps);
Parameters
- scope
Construct
- id
string
- props
EventbridgeToSnsProps
Pattern Construct Props
Name | Type | Description |
---|---|---|
eventRuleProps | events.RuleProps |
User provided eventRuleProps to override the defaults. |
existingTopicObj? | sns.Topic |
Existing instance of SNS Topic object, providing both this and topicProps will cause an error. |
topicProps? | sns.TopicProps |
User provided props to override the default props for the SNS Topic. |
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. |
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 SNS Topic. |
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 |
snsTopic | sns.Topic |
Returns an instance of sns.Topic created by the construct |
encryptionKey? | kms.Key |
Returns an instance of kms Key used for the SNS Topic. |
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 SNS Topic.
Amazon SNS Topic
- Configure least privilege access permissions for SNS Topic.
- Enable server-side encryption forSNS Topic 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-sns-1.129.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | af1f8c42cc640cd3a1bf4346c157b97a3ded5b1000031954725ed394560d0188 |
|
MD5 | 8e8f71c4fcfc9d50c3d5b5b522e006b4 |
|
BLAKE2b-256 | ab3b388fc80f3b537fd877b94353487b553b797f947f20a7b20430f82aa88442 |
Close
Hashes for aws_solutions_constructs.aws_eventbridge_sns-1.129.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b23b9a8727c2c1e64a4536af26356f47b3fa9287a308a62b02d0a8a065ba246 |
|
MD5 | aae76cfb32aaceafb12194f0f16a3cbf |
|
BLAKE2b-256 | 621e355f65fb6d6531a491d98e4dd7bb36a1f1251fe12954f6adb613b7ca7988 |