aws-cdk-lib 2.171.1__py3-none-any.whl → 2.172.0__py3-none-any.whl

aws_cdk/aws_ses/__init__.py

@@ -138,7 +138,6 @@ from aws_cdk import Duration
 
 ses.ConfigurationSet(self, "ConfigurationSet",
     custom_tracking_redirect_domain="track.cdk.dev",
-    suppression_reasons=ses.SuppressionReasons.COMPLAINTS_ONLY,
     tls_policy=ses.ConfigurationSetTlsPolicy.REQUIRE,
     dedicated_ip_pool=my_pool,
     # Specify maximum delivery time
@@ -160,6 +159,42 @@ my_configuration_set.add_event_destination("ToSns",
 )
 ```
 
+### Override account-level suppression list settings
+
+You can customize account-level suppression list separately for different configuration sets by overriding it
+with configuration set-level suppression.
+
+For details, see [Using configuration set-level suppression to override your account-level suppression list](https://docs.aws.amazon.com/ses/latest/dg/sending-email-suppression-list-config-level.html).
+
+By default, the configuration set uses your account-level suppression list settings.
+
+You can disable account-level suppression list by specifying `disableSuppressionList` to true. Email sent with this configuration set will not use any suppression settings at all.
+
+```python
+ses.ConfigurationSet(self, "ConfigurationSet",
+    disable_suppression_list=True
+)
+```
+
+You can also override account level settings with configuration set-level suppression enabled. Email sent with this configuration set will only use the suppression conditions you enabled for it (bounces, complaints, or bounces and complaints) - regardless of what your account-level suppression list settings are, it will override them.
+
+```python
+# Only bounces will be suppressed.
+ses.ConfigurationSet(self, "ConfigurationSet",
+    suppression_reasons=ses.SuppressionReasons.BOUNCES_ONLY
+)
+
+# Only complaints will be suppressed.
+ses.ConfigurationSet(self, "ConfigurationSet",
+    suppression_reasons=ses.SuppressionReasons.COMPLAINTS_ONLY
+)
+
+# Both bounces and complaints will be suppressed.
+ses.ConfigurationSet(self, "ConfigurationSet",
+    suppression_reasons=ses.SuppressionReasons.BOUNCES_AND_COMPLAINTS
+)
+```
+
 ### Email identity
 
 In Amazon SES, a verified identity is a domain or email address that you use to send or receive email. Before you
@@ -12567,6 +12602,7 @@ class ConfigurationSetEventDestinationProps(ConfigurationSetEventDestinationOpti
         "configuration_set_name": "configurationSetName",
         "custom_tracking_redirect_domain": "customTrackingRedirectDomain",
         "dedicated_ip_pool": "dedicatedIpPool",
+        "disable_suppression_list": "disableSuppressionList",
         "max_delivery_duration": "maxDeliveryDuration",
         "reputation_metrics": "reputationMetrics",
         "sending_enabled": "sendingEnabled",
@@ -12582,6 +12618,7 @@ class ConfigurationSetProps:
         configuration_set_name: typing.Optional[builtins.str] = None,
         custom_tracking_redirect_domain: typing.Optional[builtins.str] = None,
         dedicated_ip_pool: typing.Optional["IDedicatedIpPool"] = None,
+        disable_suppression_list: typing.Optional[builtins.bool] = None,
         max_delivery_duration: typing.Optional[_Duration_4839e8c3] = None,
         reputation_metrics: typing.Optional[builtins.bool] = None,
         sending_enabled: typing.Optional[builtins.bool] = None,
@@ -12594,6 +12631,7 @@ class ConfigurationSetProps:
         :param configuration_set_name: A name for the configuration set. Default: - a CloudFormation generated name
         :param custom_tracking_redirect_domain: The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain. Default: - use the default awstrack.me domain
         :param dedicated_ip_pool: The dedicated IP pool to associate with the configuration set. Default: - do not use a dedicated IP pool
+        :param disable_suppression_list: If true, account-level suppression list is disabled; email sent with this configuration set will not use any suppression settings at all Default: false
         :param max_delivery_duration: The maximum amount of time that Amazon SES API v2 will attempt delivery of email. This value must be greater than or equal to 5 minutes and less than or equal to 14 hours. Default: undefined - SES defaults to 14 hours
         :param reputation_metrics: Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. Default: true
         :param sending_enabled: Whether email sending is enabled. Default: true
@@ -12605,20 +12643,11 @@ class ConfigurationSetProps:
 
         Example::
 
-            from aws_cdk import Duration
-            
-            # my_pool: ses.IDedicatedIpPool
-            
-            
-            ses.ConfigurationSet(self, "ConfigurationSet",
-                custom_tracking_redirect_domain="track.cdk.dev",
-                suppression_reasons=ses.SuppressionReasons.COMPLAINTS_ONLY,
-                tls_policy=ses.ConfigurationSetTlsPolicy.REQUIRE,
-                dedicated_ip_pool=my_pool,
-                # Specify maximum delivery time
-                # This configuration can be useful in such cases as time-sensitive emails (like those containing a one-time-password),
-                # transactional emails, and email that you want to ensure isn't delivered during non-business hours.
-                max_delivery_duration=Duration.minutes(10)
+            ses.ConfigurationSet(self, "ConfigurationSetWithVdmOptions",
+                vdm_options=ses.VdmOptions(
+                    engagement_metrics=True,
+                    optimized_shared_delivery=True
+                )
             )
         '''
         if isinstance(vdm_options, dict):
@@ -12628,6 +12657,7 @@ class ConfigurationSetProps:
             check_type(argname="argument configuration_set_name", value=configuration_set_name, expected_type=type_hints["configuration_set_name"])
             check_type(argname="argument custom_tracking_redirect_domain", value=custom_tracking_redirect_domain, expected_type=type_hints["custom_tracking_redirect_domain"])
             check_type(argname="argument dedicated_ip_pool", value=dedicated_ip_pool, expected_type=type_hints["dedicated_ip_pool"])
+            check_type(argname="argument disable_suppression_list", value=disable_suppression_list, expected_type=type_hints["disable_suppression_list"])
             check_type(argname="argument max_delivery_duration", value=max_delivery_duration, expected_type=type_hints["max_delivery_duration"])
             check_type(argname="argument reputation_metrics", value=reputation_metrics, expected_type=type_hints["reputation_metrics"])
             check_type(argname="argument sending_enabled", value=sending_enabled, expected_type=type_hints["sending_enabled"])
@@ -12641,6 +12671,8 @@ class ConfigurationSetProps:
             self._values["custom_tracking_redirect_domain"] = custom_tracking_redirect_domain
         if dedicated_ip_pool is not None:
             self._values["dedicated_ip_pool"] = dedicated_ip_pool
+        if disable_suppression_list is not None:
+            self._values["disable_suppression_list"] = disable_suppression_list
         if max_delivery_duration is not None:
             self._values["max_delivery_duration"] = max_delivery_duration
         if reputation_metrics is not None:
@@ -12681,6 +12713,18 @@ class ConfigurationSetProps:
         result = self._values.get("dedicated_ip_pool")
         return typing.cast(typing.Optional["IDedicatedIpPool"], result)
 
+    @builtins.property
+    def disable_suppression_list(self) -> typing.Optional[builtins.bool]:
+        '''If true, account-level suppression list is disabled;
+
+        email sent with this configuration set
+        will not use any suppression settings at all
+
+        :default: false
+        '''
+        result = self._values.get("disable_suppression_list")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
     @builtins.property
     def max_delivery_duration(self) -> typing.Optional[_Duration_4839e8c3]:
         '''The maximum amount of time that Amazon SES API v2 will attempt delivery of email.
@@ -12764,7 +12808,6 @@ class ConfigurationSetTlsPolicy(enum.Enum):
         
         ses.ConfigurationSet(self, "ConfigurationSet",
             custom_tracking_redirect_domain="track.cdk.dev",
-            suppression_reasons=ses.SuppressionReasons.COMPLAINTS_ONLY,
             tls_policy=ses.ConfigurationSetTlsPolicy.REQUIRE,
             dedicated_ip_pool=my_pool,
             # Specify maximum delivery time
@@ -15387,20 +15430,19 @@ class SuppressionReasons(enum.Enum):
 
     Example::
 
-        from aws_cdk import Duration
-        
-        # my_pool: ses.IDedicatedIpPool
+        # Only bounces will be suppressed.
+        ses.ConfigurationSet(self, "ConfigurationSet",
+            suppression_reasons=ses.SuppressionReasons.BOUNCES_ONLY
+        )
         
+        # Only complaints will be suppressed.
+        ses.ConfigurationSet(self, "ConfigurationSet",
+            suppression_reasons=ses.SuppressionReasons.COMPLAINTS_ONLY
+        )
         
+        # Both bounces and complaints will be suppressed.
         ses.ConfigurationSet(self, "ConfigurationSet",
-            custom_tracking_redirect_domain="track.cdk.dev",
-            suppression_reasons=ses.SuppressionReasons.COMPLAINTS_ONLY,
-            tls_policy=ses.ConfigurationSetTlsPolicy.REQUIRE,
-            dedicated_ip_pool=my_pool,
-            # Specify maximum delivery time
-            # This configuration can be useful in such cases as time-sensitive emails (like those containing a one-time-password),
-            # transactional emails, and email that you want to ensure isn't delivered during non-business hours.
-            max_delivery_duration=Duration.minutes(10)
+            suppression_reasons=ses.SuppressionReasons.BOUNCES_AND_COMPLAINTS
         )
     '''
 
@@ -15731,20 +15773,11 @@ class ConfigurationSet(
 
     Example::
 
-        from aws_cdk import Duration
-        
-        # my_pool: ses.IDedicatedIpPool
-        
-        
-        ses.ConfigurationSet(self, "ConfigurationSet",
-            custom_tracking_redirect_domain="track.cdk.dev",
-            suppression_reasons=ses.SuppressionReasons.COMPLAINTS_ONLY,
-            tls_policy=ses.ConfigurationSetTlsPolicy.REQUIRE,
-            dedicated_ip_pool=my_pool,
-            # Specify maximum delivery time
-            # This configuration can be useful in such cases as time-sensitive emails (like those containing a one-time-password),
-            # transactional emails, and email that you want to ensure isn't delivered during non-business hours.
-            max_delivery_duration=Duration.minutes(10)
+        ses.ConfigurationSet(self, "ConfigurationSetWithVdmOptions",
+            vdm_options=ses.VdmOptions(
+                engagement_metrics=True,
+                optimized_shared_delivery=True
+            )
         )
     '''
 
@@ -15756,6 +15789,7 @@ class ConfigurationSet(
         configuration_set_name: typing.Optional[builtins.str] = None,
         custom_tracking_redirect_domain: typing.Optional[builtins.str] = None,
         dedicated_ip_pool: typing.Optional[IDedicatedIpPool] = None,
+        disable_suppression_list: typing.Optional[builtins.bool] = None,
         max_delivery_duration: typing.Optional[_Duration_4839e8c3] = None,
         reputation_metrics: typing.Optional[builtins.bool] = None,
         sending_enabled: typing.Optional[builtins.bool] = None,
@@ -15769,6 +15803,7 @@ class ConfigurationSet(
         :param configuration_set_name: A name for the configuration set. Default: - a CloudFormation generated name
         :param custom_tracking_redirect_domain: The custom subdomain that is used to redirect email recipients to the Amazon SES event tracking domain. Default: - use the default awstrack.me domain
         :param dedicated_ip_pool: The dedicated IP pool to associate with the configuration set. Default: - do not use a dedicated IP pool
+        :param disable_suppression_list: If true, account-level suppression list is disabled; email sent with this configuration set will not use any suppression settings at all Default: false
         :param max_delivery_duration: The maximum amount of time that Amazon SES API v2 will attempt delivery of email. This value must be greater than or equal to 5 minutes and less than or equal to 14 hours. Default: undefined - SES defaults to 14 hours
         :param reputation_metrics: Whether to publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. Default: true
         :param sending_enabled: Whether email sending is enabled. Default: true
@@ -15784,6 +15819,7 @@ class ConfigurationSet(
             configuration_set_name=configuration_set_name,
             custom_tracking_redirect_domain=custom_tracking_redirect_domain,
             dedicated_ip_pool=dedicated_ip_pool,
+            disable_suppression_list=disable_suppression_list,
             max_delivery_duration=max_delivery_duration,
             reputation_metrics=reputation_metrics,
             sending_enabled=sending_enabled,
@@ -18035,6 +18071,7 @@ def _typecheckingstub__fb010161f6c1e40b88122d9cb7754dae093e9cbe5bbfc72b19737729a
     configuration_set_name: typing.Optional[builtins.str] = None,
     custom_tracking_redirect_domain: typing.Optional[builtins.str] = None,
     dedicated_ip_pool: typing.Optional[IDedicatedIpPool] = None,
+    disable_suppression_list: typing.Optional[builtins.bool] = None,
     max_delivery_duration: typing.Optional[_Duration_4839e8c3] = None,
     reputation_metrics: typing.Optional[builtins.bool] = None,
     sending_enabled: typing.Optional[builtins.bool] = None,
@@ -18391,6 +18428,7 @@ def _typecheckingstub__52b42851a408d3eb2b07399f2b34603200cef443be5e9f913f4a1d80a
     configuration_set_name: typing.Optional[builtins.str] = None,
     custom_tracking_redirect_domain: typing.Optional[builtins.str] = None,
     dedicated_ip_pool: typing.Optional[IDedicatedIpPool] = None,
+    disable_suppression_list: typing.Optional[builtins.bool] = None,
     max_delivery_duration: typing.Optional[_Duration_4839e8c3] = None,
     reputation_metrics: typing.Optional[builtins.bool] = None,
     sending_enabled: typing.Optional[builtins.bool] = None,