# CDK Construct Library for Amazon Simple Notification Service Subscriptions
<!--BEGIN STABILITY BANNER-->---
> AWS CDK v1 has reached End-of-Support on 2023-06-01.
> This package is no longer being updated, and users should migrate to AWS CDK v2.
>
> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).
---
<!--END STABILITY BANNER-->
This library provides constructs for adding subscriptions to an Amazon SNS topic.
Subscriptions can be added by calling the `.addSubscription(...)` method on the topic.
## Subscriptions
Subscriptions can be added to the following endpoints:
* HTTPS
* Amazon SQS
* AWS Lambda
* Email
* SMS
Subscriptions to Amazon SQS and AWS Lambda can be added on topics across regions.
Create an Amazon SNS Topic to add subscriptions.
```python
my_topic = sns.Topic(self, "MyTopic")
```
### HTTPS
Add an HTTP or HTTPS Subscription to your topic:
```python
my_topic = sns.Topic(self, "MyTopic")
my_topic.add_subscription(subscriptions.UrlSubscription("https://foobar.com/"))
```
The URL being subscribed can also be [tokens](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html), that resolve
to a URL during deployment. A typical use case is when the URL is passed in as a [CloudFormation
parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html). The
following code defines a CloudFormation parameter and uses it in a URL subscription.
```python
my_topic = sns.Topic(self, "MyTopic")
url = CfnParameter(self, "url-param")
my_topic.add_subscription(subscriptions.UrlSubscription(url.value_as_string))
```
### Amazon SQS
Subscribe a queue to your topic:
```python
my_queue = sqs.Queue(self, "MyQueue")
my_topic = sns.Topic(self, "MyTopic")
my_topic.add_subscription(subscriptions.SqsSubscription(my_queue))
```
KMS key permissions will automatically be granted to SNS when a subscription is made to
an encrypted queue.
Note that subscriptions of queues in different accounts need to be manually confirmed by
reading the initial message from the queue and visiting the link found in it.
### AWS Lambda
Subscribe an AWS Lambda function to your topic:
```python
import aws_cdk.aws_lambda as lambda_
# my_function: lambda.Function
my_topic = sns.Topic(self, "myTopic")
my_topic.add_subscription(subscriptions.LambdaSubscription(my_function))
```
### Email
Subscribe an email address to your topic:
```python
my_topic = sns.Topic(self, "MyTopic")
my_topic.add_subscription(subscriptions.EmailSubscription("foo@bar.com"))
```
The email being subscribed can also be [tokens](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html), that resolve
to an email address during deployment. A typical use case is when the email address is passed in as a [CloudFormation
parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html). The
following code defines a CloudFormation parameter and uses it in an email subscription.
```python
my_topic = sns.Topic(self, "Topic")
email_address = CfnParameter(self, "email-param")
my_topic.add_subscription(subscriptions.EmailSubscription(email_address.value_as_string))
```
Note that email subscriptions require confirmation by visiting the link sent to the
email address.
### SMS
Subscribe an sms number to your topic:
```python
my_topic = sns.Topic(self, "Topic")
my_topic.add_subscription(subscriptions.SmsSubscription("+15551231234"))
```
The number being subscribed can also be [tokens](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html), that resolve
to a number during deployment. A typical use case is when the number is passed in as a [CloudFormation
parameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html). The
following code defines a CloudFormation parameter and uses it in an sms subscription.
```python
my_topic = sns.Topic(self, "Topic")
sms_number = CfnParameter(self, "sms-param")
my_topic.add_subscription(subscriptions.SmsSubscription(sms_number.value_as_string))
```
Raw data
{
"_id": null,
"home_page": "https://github.com/aws/aws-cdk",
"name": "aws-cdk.aws-sns-subscriptions",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/49/bc/1efb15a61aab67460b10a30d48c29039082f8d4a0add24504c28e5042ccb/aws-cdk.aws-sns-subscriptions-1.204.0.tar.gz",
"platform": null,
"description": "# CDK Construct Library for Amazon Simple Notification Service Subscriptions\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [*Migrating to AWS CDK v2* guide](https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html).\n\n---\n<!--END STABILITY BANNER-->\n\nThis library provides constructs for adding subscriptions to an Amazon SNS topic.\nSubscriptions can be added by calling the `.addSubscription(...)` method on the topic.\n\n## Subscriptions\n\nSubscriptions can be added to the following endpoints:\n\n* HTTPS\n* Amazon SQS\n* AWS Lambda\n* Email\n* SMS\n\nSubscriptions to Amazon SQS and AWS Lambda can be added on topics across regions.\n\nCreate an Amazon SNS Topic to add subscriptions.\n\n```python\nmy_topic = sns.Topic(self, \"MyTopic\")\n```\n\n### HTTPS\n\nAdd an HTTP or HTTPS Subscription to your topic:\n\n```python\nmy_topic = sns.Topic(self, \"MyTopic\")\n\nmy_topic.add_subscription(subscriptions.UrlSubscription(\"https://foobar.com/\"))\n```\n\nThe URL being subscribed can also be [tokens](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html), that resolve\nto a URL during deployment. A typical use case is when the URL is passed in as a [CloudFormation\nparameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html). The\nfollowing code defines a CloudFormation parameter and uses it in a URL subscription.\n\n```python\nmy_topic = sns.Topic(self, \"MyTopic\")\nurl = CfnParameter(self, \"url-param\")\n\nmy_topic.add_subscription(subscriptions.UrlSubscription(url.value_as_string))\n```\n\n### Amazon SQS\n\nSubscribe a queue to your topic:\n\n```python\nmy_queue = sqs.Queue(self, \"MyQueue\")\nmy_topic = sns.Topic(self, \"MyTopic\")\n\nmy_topic.add_subscription(subscriptions.SqsSubscription(my_queue))\n```\n\nKMS key permissions will automatically be granted to SNS when a subscription is made to\nan encrypted queue.\n\nNote that subscriptions of queues in different accounts need to be manually confirmed by\nreading the initial message from the queue and visiting the link found in it.\n\n### AWS Lambda\n\nSubscribe an AWS Lambda function to your topic:\n\n```python\nimport aws_cdk.aws_lambda as lambda_\n# my_function: lambda.Function\n\n\nmy_topic = sns.Topic(self, \"myTopic\")\nmy_topic.add_subscription(subscriptions.LambdaSubscription(my_function))\n```\n\n### Email\n\nSubscribe an email address to your topic:\n\n```python\nmy_topic = sns.Topic(self, \"MyTopic\")\nmy_topic.add_subscription(subscriptions.EmailSubscription(\"foo@bar.com\"))\n```\n\nThe email being subscribed can also be [tokens](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html), that resolve\nto an email address during deployment. A typical use case is when the email address is passed in as a [CloudFormation\nparameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html). The\nfollowing code defines a CloudFormation parameter and uses it in an email subscription.\n\n```python\nmy_topic = sns.Topic(self, \"Topic\")\nemail_address = CfnParameter(self, \"email-param\")\n\nmy_topic.add_subscription(subscriptions.EmailSubscription(email_address.value_as_string))\n```\n\nNote that email subscriptions require confirmation by visiting the link sent to the\nemail address.\n\n### SMS\n\nSubscribe an sms number to your topic:\n\n```python\nmy_topic = sns.Topic(self, \"Topic\")\n\nmy_topic.add_subscription(subscriptions.SmsSubscription(\"+15551231234\"))\n```\n\nThe number being subscribed can also be [tokens](https://docs.aws.amazon.com/cdk/latest/guide/tokens.html), that resolve\nto a number during deployment. A typical use case is when the number is passed in as a [CloudFormation\nparameter](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html). The\nfollowing code defines a CloudFormation parameter and uses it in an sms subscription.\n\n```python\nmy_topic = sns.Topic(self, \"Topic\")\nsms_number = CfnParameter(self, \"sms-param\")\n\nmy_topic.add_subscription(subscriptions.SmsSubscription(sms_number.value_as_string))\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CDK Subscription Constructs for AWS SNS",
"version": "1.204.0",
"project_urls": {
"Homepage": "https://github.com/aws/aws-cdk",
"Source": "https://github.com/aws/aws-cdk.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d2787a2f95575f2611bfe76c1fdad2f69378fb659c9a0ca2040324ed752428d5",
"md5": "37383a30bbf41c139a69fe9680acd024",
"sha256": "24bc33d1c3c019b36d867c3a117f5f08cc0d10c141a7d14b657f85c35ecafcce"
},
"downloads": -1,
"filename": "aws_cdk.aws_sns_subscriptions-1.204.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "37383a30bbf41c139a69fe9680acd024",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 44301,
"upload_time": "2023-06-19T21:01:31",
"upload_time_iso_8601": "2023-06-19T21:01:31.691547Z",
"url": "https://files.pythonhosted.org/packages/d2/78/7a2f95575f2611bfe76c1fdad2f69378fb659c9a0ca2040324ed752428d5/aws_cdk.aws_sns_subscriptions-1.204.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49bc1efb15a61aab67460b10a30d48c29039082f8d4a0add24504c28e5042ccb",
"md5": "598d4f4485130a780044e7b74a388200",
"sha256": "f653af8f2209a0a7146d62eef778a404214f6da120b0374790d92f3aee875210"
},
"downloads": -1,
"filename": "aws-cdk.aws-sns-subscriptions-1.204.0.tar.gz",
"has_sig": false,
"md5_digest": "598d4f4485130a780044e7b74a388200",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 45427,
"upload_time": "2023-06-19T21:07:41",
"upload_time_iso_8601": "2023-06-19T21:07:41.945736Z",
"url": "https://files.pythonhosted.org/packages/49/bc/1efb15a61aab67460b10a30d48c29039082f8d4a0add24504c28e5042ccb/aws-cdk.aws-sns-subscriptions-1.204.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-19 21:07:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws",
"github_project": "aws-cdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-cdk.aws-sns-subscriptions"
}
JSON
