SmsSubscription

class aws_cdk.aws_sns_subscriptions.SmsSubscription(phone_number, *, dead_letter_queue=None, filter_policy=None, filter_policy_with_message_body=None)

Bases: object

Use an sms address as a subscription target.

ExampleMetadata:

infused

Example:

my_topic = sns.Topic(self, "Topic")

my_topic.add_subscription(subscriptions.SmsSubscription("+15551231234"))
Parameters:

  • phone_number (str) –

  • dead_letter_queue (Optional[IQueue]) – Queue to be used as dead letter queue. If not passed no dead letter queue is enabled. Default: - No dead letter queue enabled.

  • filter_policy (Optional[Mapping[str, SubscriptionFilter]]) – The filter policy. Default: - all messages are delivered

  • filter_policy_with_message_body (Optional[Mapping[str, FilterOrPolicy]]) – The filter policy that is applied on the message body. To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used. Default: - all messages are delivered

Methods

bind(_topic)

Returns a configuration used to subscribe to an SNS topic.

Parameters:

_topic (ITopic) –

Return type:

TopicSubscriptionConfig