Metadata-Version: 2.1
Name: aws-cdk.aws-sns-subscriptions
Version: 1.18.0
Summary: CDK Subscription Constructs for AWS SNS
Home-page: https://github.com/aws/aws-cdk
Author: Amazon Web Services
License: Apache-2.0
Project-URL: Source, https://github.com/aws/aws-cdk.git
Description: # CDK Construct Library for Amazon Simple Notification Service Subscriptions
        
        <!--BEGIN STABILITY BANNER-->---
        
        
        ![Stability: Stable](https://img.shields.io/badge/stability-Stable-success.svg?style=for-the-badge)
        
        ---
        <!--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
        
        Create an Amazon SNS Topic to add subscriptions.
        
        ```python
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_sns as sns
        
        my_topic = sns.Topic(self, "MyTopic")
        ```
        
        ### HTTPS
        
        Add an HTTPS Subscription to your topic:
        
        ```python
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_sns_subscriptions as subscriptions
        
        my_topic.add_subscription(subsscriptions.UrlSubscription("https://foobar.com/"))
        ```
        
        ### Amazon SQS
        
        Subscribe a queue to your topic:
        
        ```python
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_sqs as sqs
        import aws_cdk.aws_sns_subscriptions as subscriptions
        
        my_queue = sqs.Queue(self, "MyQueue")
        
        my_topic.add_subscription(subsscriptions.SqsSubscription(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
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_lambda as lambda
        import aws_cdk.aws_sns_subscriptions as subscriptions
        
        my_function = lambda.Function(self, "Echo",
            handler="index.handler",
            runtime=lambda.Runtime.NODEJS_10_X,
            code=lambda.Code.from_inline(f"exports.handler = {handler.toString()}")
        )
        
        my_topic.add_subscription(subscriptions.LambdaSubscription(my_function))
        ```
        
        ### Email
        
        Subscribe an email address to your topic:
        
        ```python
        # Example automatically generated. See https://github.com/aws/jsii/issues/826
        import aws_cdk.aws_sns_subscriptions as subscriptions
        
        my_topic.add_subscription(subscriptions.EmailSubscription("foo@bar.com"))
        ```
        
        Note that email subscriptions require confirmation by visiting the link sent to the
        email address.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
