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 |
Overview
This AWS Solutions Construct implements an AWS Events rule and an AWS SNS Topic.
Here is a minimal deployable pattern definition:
Typescript
import { Construct } from 'constructs';
import { Stack, StackProps, Duration } from 'aws-cdk-lib';
import * as events from 'aws-cdk-lib/aws-events';
import * as iam from 'aws-cdk-lib/aws-iam';
import { EventbridgeToSnsProps, EventbridgeToSns } from "@aws-solutions-constructs/aws-eventbridge-sns";
const constructProps: EventbridgeToSnsProps = {
eventRuleProps: {
schedule: events.Schedule.rate(Duration.minutes(5))
}
};
const constructStack = new EventbridgeToSns(this, 'test-construct', constructProps);
// 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);
Python
from aws_solutions_constructs.aws_eventbridge_sns import EventbridgeToSns, EventbridgeToSnsProps
from aws_cdk import (
aws_events as events,
aws_iam as iam,
Duration,
Stack
)
from constructs import Construct
construct_stack = EventbridgeToSns(self, 'test-construct',
event_rule_props=events.RuleProps(
schedule=events.Schedule.rate(
Duration.minutes(5))
))
# 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)
Java
import software.constructs.Construct;
import java.util.List;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.Duration;
import software.amazon.awscdk.services.events.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awsconstructs.services.eventbridgesns.*;
final EventbridgeToSns constructStack = new EventbridgeToSns(this, "test-construct",
new EventbridgeToSnsProps.Builder()
.eventRuleProps(new RuleProps.Builder()
.schedule(Schedule.rate(Duration.minutes(5)))
.build())
.build());
// Grant yourself permissions to use the Customer Managed KMS Key
final PolicyStatement policyStatement = PolicyStatement.Builder.create()
.actions(List.of("kms:Encrypt", "kms:Decrypt"))
.effect(Effect.ALLOW)
.principals(List.of(new AccountRootPrincipal()))
.resources(List.of("*"))
.build();
constructStack.getEncryptionKey().addToResourcePolicy(policyStatement);
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 2022 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.160.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14bf11873e7fc62f7aec533d5fb618998cd4aa12f57c52169d43a23d364107b5 |
|
MD5 | a1f59dbc5dacf11a4433f4b3ae0ff56b |
|
BLAKE2b-256 | c54d87e8afa4dd01bd9b2a70283b4a091c0d45dd8c5db5e3b99c89975e6bb311 |
Close
Hashes for aws_solutions_constructs.aws_eventbridge_sns-1.160.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ca0da5b7f6787d11388cc32aee9ea7d89fec41f445be4ccf8edf9713835193a |
|
MD5 | ec16f71de3754fe6a03e449f9a258f86 |
|
BLAKE2b-256 | 82b21241717cd81f8dd9cd6d0fd4cc49d8b58dfe0a53d8729e00ccc6b96c9fdc |