aws-cdk-lib 2.167.2__py3-none-any.whl → 2.169.0__py3-none-any.whl

aws_cdk/aws_sns_subscriptions/__init__.py

@@ -44,6 +44,30 @@ url = CfnParameter(self, "url-param")
 my_topic.add_subscription(subscriptions.UrlSubscription(url.value_as_string))
 ```
 
+The [delivery policy](https://docs.aws.amazon.com/sns/latest/dg/sns-message-delivery-retries.html) can also be set like so:
+
+```python
+my_topic = sns.Topic(self, "MyTopic")
+
+my_topic.add_subscription(
+    subscriptions.UrlSubscription("https://foobar.com/",
+        delivery_policy=sns.DeliveryPolicy(
+            healthy_retry_policy=sns.HealthyRetryPolicy(
+                min_delay_target=Duration.seconds(5),
+                max_delay_target=Duration.seconds(10),
+                num_retries=6,
+                backoff_function=sns.BackoffFunction.EXPONENTIAL
+            ),
+            throttle_policy=sns.ThrottlePolicy(
+                max_receives_per_second=10
+            ),
+            request_policy=sns.RequestPolicy(
+                header_content_type="application/json"
+            )
+        )
+    ))
+```
+
 ### Amazon SQS
 
 Subscribe a queue to your topic:
@@ -154,6 +178,7 @@ from .._jsii import *
 
 from ..aws_lambda import IFunction as _IFunction_6adb0ab8
 from ..aws_sns import (
+    DeliveryPolicy as _DeliveryPolicy_76b14b4e,
     FilterOrPolicy as _FilterOrPolicy_ad79be59,
     ITopic as _ITopic_9eca4852,
     ITopicSubscription as _ITopicSubscription_363a9426,
@@ -523,14 +548,16 @@ class UrlSubscription(
     Example::
 
         my_topic = sns.Topic(self, "MyTopic")
+        url = CfnParameter(self, "url-param")
         
-        my_topic.add_subscription(subscriptions.UrlSubscription("https://foobar.com/"))
+        my_topic.add_subscription(subscriptions.UrlSubscription(url.value_as_string))
     '''
 
     def __init__(
         self,
         url: builtins.str,
         *,
+        delivery_policy: typing.Optional[typing.Union[_DeliveryPolicy_76b14b4e, typing.Dict[builtins.str, typing.Any]]] = None,
         protocol: typing.Optional[_SubscriptionProtocol_0df4af69] = None,
         raw_message_delivery: typing.Optional[builtins.bool] = None,
         dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
@@ -539,6 +566,7 @@ class UrlSubscription(
     ) -> None:
         '''
         :param url: -
+        :param delivery_policy: The delivery policy. Default: - if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds
         :param protocol: The subscription's protocol. Default: - Protocol is derived from url
         :param raw_message_delivery: The message to the queue is the same as it was sent to the topic. If false, the message will be wrapped in an SNS envelope. Default: false
         :param dead_letter_queue: Queue to be used as dead letter queue. If not passed no dead letter queue is enabled. Default: - No dead letter queue enabled.
@@ -549,6 +577,7 @@ class UrlSubscription(
             type_hints = typing.get_type_hints(_typecheckingstub__fb20fb5ebe87494e3bac5aa1faafa0ee8b89a54b69e6bd2c759c374b193a6dfc)
             check_type(argname="argument url", value=url, expected_type=type_hints["url"])
         props = UrlSubscriptionProps(
+            delivery_policy=delivery_policy,
             protocol=protocol,
             raw_message_delivery=raw_message_delivery,
             dead_letter_queue=dead_letter_queue,
@@ -577,6 +606,7 @@ class UrlSubscription(
         "dead_letter_queue": "deadLetterQueue",
         "filter_policy": "filterPolicy",
         "filter_policy_with_message_body": "filterPolicyWithMessageBody",
+        "delivery_policy": "deliveryPolicy",
         "protocol": "protocol",
         "raw_message_delivery": "rawMessageDelivery",
     },
@@ -588,6 +618,7 @@ class UrlSubscriptionProps(SubscriptionProps):
         dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
         filter_policy: typing.Optional[typing.Mapping[builtins.str, _SubscriptionFilter_8e774360]] = None,
         filter_policy_with_message_body: typing.Optional[typing.Mapping[builtins.str, _FilterOrPolicy_ad79be59]] = None,
+        delivery_policy: typing.Optional[typing.Union[_DeliveryPolicy_76b14b4e, typing.Dict[builtins.str, typing.Any]]] = None,
         protocol: typing.Optional[_SubscriptionProtocol_0df4af69] = None,
         raw_message_delivery: typing.Optional[builtins.bool] = None,
     ) -> None:
@@ -596,40 +627,42 @@ class UrlSubscriptionProps(SubscriptionProps):
         :param dead_letter_queue: Queue to be used as dead letter queue. If not passed no dead letter queue is enabled. Default: - No dead letter queue enabled.
         :param filter_policy: The filter policy. Default: - all messages are delivered
         :param filter_policy_with_message_body: 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
+        :param delivery_policy: The delivery policy. Default: - if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds
         :param protocol: The subscription's protocol. Default: - Protocol is derived from url
         :param raw_message_delivery: The message to the queue is the same as it was sent to the topic. If false, the message will be wrapped in an SNS envelope. Default: false
 
-        :exampleMetadata: fixture=_generated
+        :exampleMetadata: infused
 
         Example::
 
-            # The code below shows an example of how to instantiate this type.
-            # The values are placeholders you should change.
-            from aws_cdk import aws_sns as sns
-            from aws_cdk import aws_sns_subscriptions as sns_subscriptions
-            from aws_cdk import aws_sqs as sqs
-            
-            # filter_or_policy: sns.FilterOrPolicy
-            # queue: sqs.Queue
-            # subscription_filter: sns.SubscriptionFilter
+            my_topic = sns.Topic(self, "MyTopic")
             
-            url_subscription_props = sns_subscriptions.UrlSubscriptionProps(
-                dead_letter_queue=queue,
-                filter_policy={
-                    "filter_policy_key": subscription_filter
-                },
-                filter_policy_with_message_body={
-                    "filter_policy_with_message_body_key": filter_or_policy
-                },
-                protocol=sns.SubscriptionProtocol.HTTP,
-                raw_message_delivery=False
-            )
+            my_topic.add_subscription(
+                subscriptions.UrlSubscription("https://foobar.com/",
+                    delivery_policy=sns.DeliveryPolicy(
+                        healthy_retry_policy=sns.HealthyRetryPolicy(
+                            min_delay_target=Duration.seconds(5),
+                            max_delay_target=Duration.seconds(10),
+                            num_retries=6,
+                            backoff_function=sns.BackoffFunction.EXPONENTIAL
+                        ),
+                        throttle_policy=sns.ThrottlePolicy(
+                            max_receives_per_second=10
+                        ),
+                        request_policy=sns.RequestPolicy(
+                            header_content_type="application/json"
+                        )
+                    )
+                ))
         '''
+        if isinstance(delivery_policy, dict):
+            delivery_policy = _DeliveryPolicy_76b14b4e(**delivery_policy)
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__abe65add18291230d30a8771d08cd51f9f4eb89c5f1844a384570386c2c534ed)
             check_type(argname="argument dead_letter_queue", value=dead_letter_queue, expected_type=type_hints["dead_letter_queue"])
             check_type(argname="argument filter_policy", value=filter_policy, expected_type=type_hints["filter_policy"])
             check_type(argname="argument filter_policy_with_message_body", value=filter_policy_with_message_body, expected_type=type_hints["filter_policy_with_message_body"])
+            check_type(argname="argument delivery_policy", value=delivery_policy, expected_type=type_hints["delivery_policy"])
             check_type(argname="argument protocol", value=protocol, expected_type=type_hints["protocol"])
             check_type(argname="argument raw_message_delivery", value=raw_message_delivery, expected_type=type_hints["raw_message_delivery"])
         self._values: typing.Dict[builtins.str, typing.Any] = {}
@@ -639,6 +672,8 @@ class UrlSubscriptionProps(SubscriptionProps):
             self._values["filter_policy"] = filter_policy
         if filter_policy_with_message_body is not None:
             self._values["filter_policy_with_message_body"] = filter_policy_with_message_body
+        if delivery_policy is not None:
+            self._values["delivery_policy"] = delivery_policy
         if protocol is not None:
             self._values["protocol"] = protocol
         if raw_message_delivery is not None:
@@ -679,6 +714,15 @@ class UrlSubscriptionProps(SubscriptionProps):
         result = self._values.get("filter_policy_with_message_body")
         return typing.cast(typing.Optional[typing.Mapping[builtins.str, _FilterOrPolicy_ad79be59]], result)
 
+    @builtins.property
+    def delivery_policy(self) -> typing.Optional[_DeliveryPolicy_76b14b4e]:
+        '''The delivery policy.
+
+        :default: - if the initial delivery of the message fails, three retries with a delay between failed attempts set at 20 seconds
+        '''
+        result = self._values.get("delivery_policy")
+        return typing.cast(typing.Optional[_DeliveryPolicy_76b14b4e], result)
+
     @builtins.property
     def protocol(self) -> typing.Optional[_SubscriptionProtocol_0df4af69]:
         '''The subscription's protocol.
@@ -1276,6 +1320,7 @@ def _typecheckingstub__8cd177765ba71e4e5ee7174b2edc60b767a4303c5d9db2cdd1e6a1925
 def _typecheckingstub__fb20fb5ebe87494e3bac5aa1faafa0ee8b89a54b69e6bd2c759c374b193a6dfc(
     url: builtins.str,
     *,
+    delivery_policy: typing.Optional[typing.Union[_DeliveryPolicy_76b14b4e, typing.Dict[builtins.str, typing.Any]]] = None,
     protocol: typing.Optional[_SubscriptionProtocol_0df4af69] = None,
     raw_message_delivery: typing.Optional[builtins.bool] = None,
     dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
@@ -1296,6 +1341,7 @@ def _typecheckingstub__abe65add18291230d30a8771d08cd51f9f4eb89c5f1844a384570386c
     dead_letter_queue: typing.Optional[_IQueue_7ed6f679] = None,
     filter_policy: typing.Optional[typing.Mapping[builtins.str, _SubscriptionFilter_8e774360]] = None,
     filter_policy_with_message_body: typing.Optional[typing.Mapping[builtins.str, _FilterOrPolicy_ad79be59]] = None,
+    delivery_policy: typing.Optional[typing.Union[_DeliveryPolicy_76b14b4e, typing.Dict[builtins.str, typing.Any]]] = None,
     protocol: typing.Optional[_SubscriptionProtocol_0df4af69] = None,
     raw_message_delivery: typing.Optional[builtins.bool] = None,
 ) -> None: