# @aws-solutions-constructs/aws-events-rule-sns > CDK Constructs for deploying AWS Events Rule that invokes AWS SNS Latest version **1.146.0** (published 2022-03-02) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @aws-solutions-constructs/aws-events-rule-sns pnpm add @aws-solutions-constructs/aws-events-rule-sns yarn add @aws-solutions-constructs/aws-events-rule-sns bun add @aws-solutions-constructs/aws-events-rule-sns ``` ## Health **Score 40/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 1.146.0 | | Published | 2022-03-02 | | First published | 2020-09-10 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 8 | | Unpacked size | 335.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1361 | | Author | Amazon Web Services | | Maintainers | aws-solutions-constructs-team | | Keywords | aws, cdk, awscdk, AWS Solutions Constructs, Amazon EventBridge, Amazon SNS | ## Links - npm: https://www.npmjs.com/package/@aws-solutions-constructs/aws-events-rule-sns - Repository: https://github.com/awslabs/aws-solutions-constructs - Homepage: https://github.com/awslabs/aws-solutions-constructs#readme - Issues: https://github.com/awslabs/aws-solutions-constructs/issues - npm.io page: https://npm.io/package/@aws-solutions-constructs/aws-events-rule-sns ## Dependencies (8) - [constructs](https://npm.io/package/constructs.md) ^3.2.0 - [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) 1.146.0 - [@aws-cdk/aws-iam](https://npm.io/package/@aws-cdk/aws-iam.md) 1.146.0 - [@aws-cdk/aws-kms](https://npm.io/package/@aws-cdk/aws-kms.md) 1.146.0 - [@aws-cdk/aws-sns](https://npm.io/package/@aws-cdk/aws-sns.md) 1.146.0 - [@aws-cdk/aws-events](https://npm.io/package/@aws-cdk/aws-events.md) 1.146.0 - [@aws-solutions-constructs/core](https://npm.io/package/@aws-solutions-constructs/core.md) 1.146.0 - [@aws-solutions-constructs/aws-eventbridge-sns](https://npm.io/package/@aws-solutions-constructs/aws-eventbridge-sns.md) 1.146.0 ## Alternatives - [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads - [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads - [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads - [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads - [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads ## Recent versions - 1.146.0 (latest) — 2022-03-02 - 1.181.1 (v1-latest) — 2022-12-02 - 1.181.0 — 2022-12-02 - 1.180.0 — 2022-12-02 - 1.179.0 — 2022-12-02 - 1.178.0 — 2022-12-02 - 1.177.0 — 2022-12-01 - 1.176.0 — 2022-12-01 - 1.175.0 — 2022-12-01 - 1.174.0 — 2022-12-01 - 1.173.0 — 2022-09-18 - 1.172.0 — 2022-09-18 - 1.171.0 — 2022-09-18 - 1.170.1 — 2022-09-18 - 1.170.0 — 2022-09-14 - … 122 more at https://npm.io/package/@aws-solutions-constructs/aws-events-rule-sns/versions ## README # aws-events-rule-sns module --- ![Stability: Deprecated](https://img.shields.io/badge/STABILITY-DEPRECATED-red?style=for-the-badge) > 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 Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_events_rule_sns`| |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-events-rule-sns`| |![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) 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: ``` typescript 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 ``` text new EventsRuleToSns(scope: Construct, id: string, props: EventsRuleToSnsProps); ``` _Parameters_ * scope [`Construct`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html) * id `string` * props [`EventsRuleToSnsProps`](#pattern-construct-props) ## Pattern Construct Props | **Name** | **Type** | **Description** | |:-------------|:----------------|-----------------| |eventRuleProps|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.RuleProps.html)|User provided eventRuleProps to override the defaults. | |existingTopicObj?|[`sns.Topic`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|Existing instance of SNS Topic object, providing both this and `topicProps` will cause an error.| |topicProps?|[`sns.TopicProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sns.TopicProps.html)|User provided props to override the default props for the SNS Topic. | |existingEventBusInterface?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.IEventBus.html)| Optional user-provided custom EventBus for construct to use. Providing both this and `eventBusProps` results an error.| |eventBusProps?|[`events.EventBusProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.EventBusProps.html)|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`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.Key.html)|An optional, imported encryption key to encrypt the SNS Topic.| |encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.KeyProps.html)|An optional, user provided properties to override the default properties for the KMS encryption key.| ## Pattern Properties | **Name** | **Type** | **Description** | |:-------------|:----------------|-----------------| |eventBus?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.IEventBus.html)|Returns the instance of events.IEventBus used by the construct| |eventsRule|[`events.Rule`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.Rule.html)|Returns an instance of events.Rule created by the construct| |snsTopic|[`sns.Topic`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sns.Topic.html)|Returns an instance of sns.Topic created by the construct| |encryptionKey?|[`kms.Key`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.Key.html)|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 ![Architecture Diagram](architecture.png) *** © Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved. --- _Source: https://npm.io/package/@aws-solutions-constructs/aws-events-rule-sns · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._