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 |
---|---|
aws_solutions_constructs.aws_eventbridge_sns |
|
@aws-solutions-constructs/aws-eventbridge-sns |
|
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:
import { Duration } from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { EventbridgeToSnsProps, EventbridgeToSns } from "@aws-solutions-constructs/aws-eventbridge-sns";
const props: EventbridgeToSnsProps = {
eventRuleProps: {
schedule: events.Schedule.rate(Duration.minutes(5)),
}
};
const constructStack = new EventbridgeToSns(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 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-2.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f864cc6e1a7f38e1bc33be7a10fa8eba3a99a972cbcaae146d9d12c66a2aeb4 |
|
MD5 | 788d5c97110e7285872952f8698745df |
|
BLAKE2b-256 | e9d53e16108f11b131fab0419a061b968a948b9b61dd02fc375006b1097b6398 |
Close
Hashes for aws_solutions_constructs.aws_eventbridge_sns-2.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a35bf33518fb3e6c11e561bdbf61a187cb96c3ce2152c3a90f2fa939125cc10e |
|
MD5 | 097ef804930a6cc6d4c0ce46e67e9623 |
|
BLAKE2b-256 | c7e516e9375b0b75f8690b33347eb390b0597b975761488cfa959286da0583fc |