CDK Constructs for deploying AWS Events Rule that invokes AWS SNS
Project description
aws-events-rule-sns module
---Some of our early constructs don’t meet the naming standards that evolved for the library. We are releasing completely feature compatible versions with corrected names. The underlying implementation code is the same regardless of whether you deploy the construct using the old or new name. We will support both names for all 1.x releases, but in 2.x we will only publish the correctly named constructs. This construct is being replaced by the functionally identical aws-eventbridge-sns.
Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_events_rule_sns |
Typescript | @aws-solutions-constructs/aws-events-rule-sns |
Java | software.amazon.awsconstructs.services.eventsrulesns |
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.
import { Duration } from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { EventsRuleToSnsProps, EventsRuleToSns } from "@aws-solutions-constructs/aws-events-rule-sns";
const props: EventsRuleToSnsProps = {
eventRuleProps: {
schedule: events.Schedule.rate(Duration.minutes(5)),
}
};
const constructStack = new EventsRuleToSns(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 EventsRuleToSns(scope: Construct, id: string, props: EventsRuleToSnsProps);
Parameters
- scope
Construct
- id
string
- props
EventsRuleToSnsProps
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
Hashes for aws-solutions-constructs.aws-events-rule-sns-1.132.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce794966f21bd32b7669f9b81702ed0776c5b4336dc269a8ed789817cfad4468 |
|
MD5 | 1000d074958259cdd4c3122cc9aceb64 |
|
BLAKE2b-256 | f6be70f4ad8b96d4d69ee4c203cfe6d95adff195b8f4827cb3f882803cd607e4 |
Hashes for aws_solutions_constructs.aws_events_rule_sns-1.132.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3eecc398c37505c39a99386371c90ec4f0b9dc51814df075710294578a8f14c |
|
MD5 | 5053493d5bf005f28631dd127e65fb4b |
|
BLAKE2b-256 | aa3d60ca9e889d548b676570f501082fca35edba91c46b697c49e116ed15530a |