Skip to main content

CDK Constructs for deploying AWS Events Rule that invokes AWS SNS

Project description

aws-events-rule-sns module

---

Stability: Experimental

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_events_rule_sns
Typescript Logo Typescript @aws-solutions-constructs/aws-events-rule-sns
Java Logo 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 without compilation. See https://github.com/aws/jsii/issues/826
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_events_rule_sns import EventsRuleToSnsProps, EventsRuleToSns

props = EventsRuleToSnsProps(
    event_rule_props=RuleProps(
        schedule=events.Schedule.rate(Duration.minutes(5))
    )
)

construct_stack = EventsRuleToSns(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 EventsRuleToSns(scope: Construct, id: string, props: EventsRuleToSnsProps);

Parameters

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, if this is set then the topicProps is ignored.
topicProps? sns.TopicProps User provided props to override the default props for the SNS Topic.
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
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 CloudWatch Events Rule

  • Grant least privilege permissions to CloudWatch Events 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

Architecture Diagram


© Copyright 2020 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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page