aws-cdk-lib 2.148.1__py3-none-any.whl → 2.149.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.148.1.jsii.tgz → aws-cdk-lib@2.149.0.jsii.tgz} +0 -0
- aws_cdk/aws_applicationautoscaling/__init__.py +16 -12
- aws_cdk/aws_bedrock/__init__.py +30 -2
- aws_cdk/aws_codebuild/__init__.py +57 -5
- aws_cdk/aws_codecommit/__init__.py +103 -0
- aws_cdk/aws_codedeploy/__init__.py +251 -5
- aws_cdk/aws_codepipeline/__init__.py +69 -0
- aws_cdk/aws_codestarnotifications/__init__.py +90 -4
- aws_cdk/aws_deadline/__init__.py +9 -15
- aws_cdk/aws_dms/__init__.py +10 -10
- aws_cdk/aws_ec2/__init__.py +4 -0
- aws_cdk/aws_emr/__init__.py +8 -8
- aws_cdk/aws_events/__init__.py +1 -13
- aws_cdk/aws_kinesisanalytics/__init__.py +11 -11
- aws_cdk/aws_kinesisanalyticsv2/__init__.py +11 -11
- aws_cdk/aws_rds/__init__.py +3 -3
- aws_cdk/aws_rolesanywhere/__init__.py +22 -13
- aws_cdk/aws_route53profiles/__init__.py +4 -4
- aws_cdk/aws_s3/__init__.py +15 -117
- aws_cdk/aws_ses/__init__.py +119 -102
- aws_cdk/aws_stepfunctions_tasks/__init__.py +209 -16
- aws_cdk/aws_verifiedpermissions/__init__.py +7 -9
- aws_cdk/aws_wafv2/__init__.py +10 -16
- aws_cdk/aws_workspaces/__init__.py +86 -56
- {aws_cdk_lib-2.148.1.dist-info → aws_cdk_lib-2.149.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.148.1.dist-info → aws_cdk_lib-2.149.0.dist-info}/RECORD +31 -31
- {aws_cdk_lib-2.148.1.dist-info → aws_cdk_lib-2.149.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.148.1.dist-info → aws_cdk_lib-2.149.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.148.1.dist-info → aws_cdk_lib-2.149.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.148.1.dist-info → aws_cdk_lib-2.149.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_ses/__init__.py
CHANGED
|
@@ -742,12 +742,12 @@ class CfnConfigurationSet(
|
|
|
742
742
|
'''
|
|
743
743
|
:param scope: Scope in which this resource is defined.
|
|
744
744
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
745
|
-
:param delivery_options: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
|
745
|
+
:param delivery_options: Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
|
746
746
|
:param name: The name of the configuration set. The name must meet the following requirements:. - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer.
|
|
747
|
-
:param reputation_options: An object that
|
|
747
|
+
:param reputation_options: An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
|
|
748
748
|
:param sending_options: An object that defines whether or not Amazon SES can send email that you send using the configuration set.
|
|
749
749
|
:param suppression_options: An object that contains information about the suppression list preferences for your account.
|
|
750
|
-
:param tracking_options:
|
|
750
|
+
:param tracking_options: An object that defines the open and click tracking options for emails that you send using the configuration set.
|
|
751
751
|
:param vdm_options: The Virtual Deliverability Manager (VDM) options that apply to the configuration set.
|
|
752
752
|
'''
|
|
753
753
|
if __debug__:
|
|
@@ -806,7 +806,7 @@ class CfnConfigurationSet(
|
|
|
806
806
|
def delivery_options(
|
|
807
807
|
self,
|
|
808
808
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSet.DeliveryOptionsProperty"]]:
|
|
809
|
-
'''Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).'''
|
|
809
|
+
'''Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).'''
|
|
810
810
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSet.DeliveryOptionsProperty"]], jsii.get(self, "deliveryOptions"))
|
|
811
811
|
|
|
812
812
|
@delivery_options.setter
|
|
@@ -840,7 +840,7 @@ class CfnConfigurationSet(
|
|
|
840
840
|
def reputation_options(
|
|
841
841
|
self,
|
|
842
842
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSet.ReputationOptionsProperty"]]:
|
|
843
|
-
'''An object that
|
|
843
|
+
'''An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.'''
|
|
844
844
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSet.ReputationOptionsProperty"]], jsii.get(self, "reputationOptions"))
|
|
845
845
|
|
|
846
846
|
@reputation_options.setter
|
|
@@ -894,7 +894,7 @@ class CfnConfigurationSet(
|
|
|
894
894
|
def tracking_options(
|
|
895
895
|
self,
|
|
896
896
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSet.TrackingOptionsProperty"]]:
|
|
897
|
-
'''
|
|
897
|
+
'''An object that defines the open and click tracking options for emails that you send using the configuration set.'''
|
|
898
898
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSet.TrackingOptionsProperty"]], jsii.get(self, "trackingOptions"))
|
|
899
899
|
|
|
900
900
|
@tracking_options.setter
|
|
@@ -932,7 +932,7 @@ class CfnConfigurationSet(
|
|
|
932
932
|
)
|
|
933
933
|
class DashboardOptionsProperty:
|
|
934
934
|
def __init__(self, *, engagement_metrics: builtins.str) -> None:
|
|
935
|
-
'''
|
|
935
|
+
'''An object containing additional settings for your VDM configuration as applicable to the Dashboard.
|
|
936
936
|
|
|
937
937
|
:param engagement_metrics: Specifies the status of your VDM engagement metrics collection. Can be one of the following:. - ``ENABLED`` – Amazon SES enables engagement metrics for the configuration set. - ``DISABLED`` – Amazon SES disables engagement metrics for the configuration set.
|
|
938
938
|
|
|
@@ -995,7 +995,7 @@ class CfnConfigurationSet(
|
|
|
995
995
|
sending_pool_name: typing.Optional[builtins.str] = None,
|
|
996
996
|
tls_policy: typing.Optional[builtins.str] = None,
|
|
997
997
|
) -> None:
|
|
998
|
-
'''Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
|
998
|
+
'''Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
|
999
999
|
|
|
1000
1000
|
:param sending_pool_name: The name of the dedicated IP pool to associate with the configuration set.
|
|
1001
1001
|
:param tls_policy: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is ``REQUIRE`` , messages are only delivered if a TLS connection can be established. If the value is ``OPTIONAL`` , messages can be delivered in plain text if a TLS connection can't be established. Valid Values: ``REQUIRE | OPTIONAL``
|
|
@@ -1064,7 +1064,7 @@ class CfnConfigurationSet(
|
|
|
1064
1064
|
)
|
|
1065
1065
|
class GuardianOptionsProperty:
|
|
1066
1066
|
def __init__(self, *, optimized_shared_delivery: builtins.str) -> None:
|
|
1067
|
-
'''
|
|
1067
|
+
'''An object containing additional settings for your VDM configuration as applicable to the Guardian.
|
|
1068
1068
|
|
|
1069
1069
|
:param optimized_shared_delivery: Specifies the status of your VDM optimized shared delivery. Can be one of the following:. - ``ENABLED`` – Amazon SES enables optimized shared delivery for the configuration set. - ``DISABLED`` – Amazon SES disables optimized shared delivery for the configuration set.
|
|
1070
1070
|
|
|
@@ -1123,9 +1123,9 @@ class CfnConfigurationSet(
|
|
|
1123
1123
|
*,
|
|
1124
1124
|
reputation_metrics_enabled: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
1125
1125
|
) -> None:
|
|
1126
|
-
'''
|
|
1126
|
+
'''Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
|
|
1127
1127
|
|
|
1128
|
-
:param reputation_metrics_enabled:
|
|
1128
|
+
:param reputation_metrics_enabled: If ``true`` , tracking of reputation metrics is enabled for the configuration set. If ``false`` , tracking of reputation metrics is disabled for the configuration set.
|
|
1129
1129
|
|
|
1130
1130
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-reputationoptions.html
|
|
1131
1131
|
:exampleMetadata: fixture=_generated
|
|
@@ -1151,9 +1151,9 @@ class CfnConfigurationSet(
|
|
|
1151
1151
|
def reputation_metrics_enabled(
|
|
1152
1152
|
self,
|
|
1153
1153
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
1154
|
-
'''
|
|
1154
|
+
'''If ``true`` , tracking of reputation metrics is enabled for the configuration set.
|
|
1155
1155
|
|
|
1156
|
-
If
|
|
1156
|
+
If ``false`` , tracking of reputation metrics is disabled for the configuration set.
|
|
1157
1157
|
|
|
1158
1158
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-reputationoptions.html#cfn-ses-configurationset-reputationoptions-reputationmetricsenabled
|
|
1159
1159
|
'''
|
|
@@ -1301,9 +1301,11 @@ class CfnConfigurationSet(
|
|
|
1301
1301
|
*,
|
|
1302
1302
|
custom_redirect_domain: typing.Optional[builtins.str] = None,
|
|
1303
1303
|
) -> None:
|
|
1304
|
-
'''
|
|
1304
|
+
'''An object that defines the tracking options for a configuration set.
|
|
1305
|
+
|
|
1306
|
+
When you use the Amazon SES API v2 to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.
|
|
1305
1307
|
|
|
1306
|
-
This domain captures open and click events generated by Amazon SES emails.
|
|
1308
|
+
You can optionally configure a custom subdomain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.
|
|
1307
1309
|
|
|
1308
1310
|
For more information, see `Configuring Custom Domains to Handle Open and Click Tracking <https://docs.aws.amazon.com/ses/latest/dg/configure-custom-open-click-domains.html>`_ in the *Amazon SES Developer Guide* .
|
|
1309
1311
|
|
|
@@ -1366,8 +1368,8 @@ class CfnConfigurationSet(
|
|
|
1366
1368
|
) -> None:
|
|
1367
1369
|
'''The Virtual Deliverability Manager (VDM) options that apply to a configuration set.
|
|
1368
1370
|
|
|
1369
|
-
:param dashboard_options:
|
|
1370
|
-
:param guardian_options:
|
|
1371
|
+
:param dashboard_options: Specifies additional settings for your VDM configuration as applicable to the Dashboard.
|
|
1372
|
+
:param guardian_options: Specifies additional settings for your VDM configuration as applicable to the Guardian.
|
|
1371
1373
|
|
|
1372
1374
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html
|
|
1373
1375
|
:exampleMetadata: fixture=_generated
|
|
@@ -1401,7 +1403,7 @@ class CfnConfigurationSet(
|
|
|
1401
1403
|
def dashboard_options(
|
|
1402
1404
|
self,
|
|
1403
1405
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSet.DashboardOptionsProperty"]]:
|
|
1404
|
-
'''
|
|
1406
|
+
'''Specifies additional settings for your VDM configuration as applicable to the Dashboard.
|
|
1405
1407
|
|
|
1406
1408
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html#cfn-ses-configurationset-vdmoptions-dashboardoptions
|
|
1407
1409
|
'''
|
|
@@ -1412,7 +1414,7 @@ class CfnConfigurationSet(
|
|
|
1412
1414
|
def guardian_options(
|
|
1413
1415
|
self,
|
|
1414
1416
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSet.GuardianOptionsProperty"]]:
|
|
1415
|
-
'''
|
|
1417
|
+
'''Specifies additional settings for your VDM configuration as applicable to the Guardian.
|
|
1416
1418
|
|
|
1417
1419
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationset-vdmoptions.html#cfn-ses-configurationset-vdmoptions-guardianoptions
|
|
1418
1420
|
'''
|
|
@@ -1439,7 +1441,9 @@ class CfnConfigurationSetEventDestination(
|
|
|
1439
1441
|
):
|
|
1440
1442
|
'''Specifies a configuration set event destination.
|
|
1441
1443
|
|
|
1442
|
-
|
|
1444
|
+
*Events* include message sends, deliveries, opens, clicks, bounces, and complaints. *Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
|
|
1445
|
+
|
|
1446
|
+
A single configuration set can include more than one event destination.
|
|
1443
1447
|
|
|
1444
1448
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html
|
|
1445
1449
|
:cloudformationResource: AWS::SES::ConfigurationSetEventDestination
|
|
@@ -1492,7 +1496,7 @@ class CfnConfigurationSetEventDestination(
|
|
|
1492
1496
|
:param scope: Scope in which this resource is defined.
|
|
1493
1497
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
1494
1498
|
:param configuration_set_name: The name of the configuration set that contains the event destination.
|
|
1495
|
-
:param event_destination:
|
|
1499
|
+
:param event_destination: An object that defines the event destination.
|
|
1496
1500
|
'''
|
|
1497
1501
|
if __debug__:
|
|
1498
1502
|
type_hints = typing.get_type_hints(_typecheckingstub__e0376f935c1363b5c7cfddd668508c112d2a00f2637b1a84086b70c96af9e53c)
|
|
@@ -1566,7 +1570,7 @@ class CfnConfigurationSetEventDestination(
|
|
|
1566
1570
|
def event_destination(
|
|
1567
1571
|
self,
|
|
1568
1572
|
) -> typing.Union[_IResolvable_da3f097b, "CfnConfigurationSetEventDestination.EventDestinationProperty"]:
|
|
1569
|
-
'''
|
|
1573
|
+
'''An object that defines the event destination.'''
|
|
1570
1574
|
return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnConfigurationSetEventDestination.EventDestinationProperty"], jsii.get(self, "eventDestination"))
|
|
1571
1575
|
|
|
1572
1576
|
@event_destination.setter
|
|
@@ -1590,11 +1594,11 @@ class CfnConfigurationSetEventDestination(
|
|
|
1590
1594
|
*,
|
|
1591
1595
|
dimension_configurations: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnConfigurationSetEventDestination.DimensionConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
1592
1596
|
) -> None:
|
|
1593
|
-
'''
|
|
1597
|
+
'''An object that defines an Amazon CloudWatch destination for email events.
|
|
1594
1598
|
|
|
1595
|
-
|
|
1599
|
+
You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
|
|
1596
1600
|
|
|
1597
|
-
:param dimension_configurations:
|
|
1601
|
+
:param dimension_configurations: An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
|
|
1598
1602
|
|
|
1599
1603
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html
|
|
1600
1604
|
:exampleMetadata: fixture=_generated
|
|
@@ -1624,7 +1628,7 @@ class CfnConfigurationSetEventDestination(
|
|
|
1624
1628
|
def dimension_configurations(
|
|
1625
1629
|
self,
|
|
1626
1630
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSetEventDestination.DimensionConfigurationProperty"]]]]:
|
|
1627
|
-
'''
|
|
1631
|
+
'''An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.
|
|
1628
1632
|
|
|
1629
1633
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-cloudwatchdestination.html#cfn-ses-configurationseteventdestination-cloudwatchdestination-dimensionconfigurations
|
|
1630
1634
|
'''
|
|
@@ -1659,13 +1663,11 @@ class CfnConfigurationSetEventDestination(
|
|
|
1659
1663
|
dimension_name: builtins.str,
|
|
1660
1664
|
dimension_value_source: builtins.str,
|
|
1661
1665
|
) -> None:
|
|
1662
|
-
'''
|
|
1666
|
+
'''An object that defines the dimension configuration to use when you send email events to Amazon CloudWatch.
|
|
1663
1667
|
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
:param
|
|
1667
|
-
:param dimension_name: The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must meet the following requirements: - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), dashes (-), or colons (:). - Contain 256 characters or fewer.
|
|
1668
|
-
:param dimension_value_source: The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an ``X-SES-MESSAGE-TAGS`` header or a parameter to the ``SendEmail`` / ``SendRawEmail`` API, specify ``messageTag`` . To use your own email headers, specify ``emailHeader`` . To put a custom tag on any link included in your email, specify ``linkTag`` .
|
|
1668
|
+
:param default_dimension_value: The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria: - Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.). - It can contain no more than 256 characters.
|
|
1669
|
+
:param dimension_name: The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria: - It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-). - It can contain no more than 256 characters.
|
|
1670
|
+
:param dimension_value_source: The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. To use the message tags that you specify using an ``X-SES-MESSAGE-TAGS`` header or a parameter to the ``SendEmail`` or ``SendRawEmail`` API, choose ``messageTag`` . To use your own email headers, choose ``emailHeader`` . To use link tags, choose ``linkTag`` .
|
|
1669
1671
|
|
|
1670
1672
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html
|
|
1671
1673
|
:exampleMetadata: fixture=_generated
|
|
@@ -1695,12 +1697,12 @@ class CfnConfigurationSetEventDestination(
|
|
|
1695
1697
|
|
|
1696
1698
|
@builtins.property
|
|
1697
1699
|
def default_dimension_value(self) -> builtins.str:
|
|
1698
|
-
'''The default value of the dimension that is published to Amazon CloudWatch if you
|
|
1700
|
+
'''The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email.
|
|
1699
1701
|
|
|
1700
|
-
|
|
1702
|
+
This value has to meet the following criteria:
|
|
1701
1703
|
|
|
1702
|
-
-
|
|
1703
|
-
-
|
|
1704
|
+
- Can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-), at signs (@), and periods (.).
|
|
1705
|
+
- It can contain no more than 256 characters.
|
|
1704
1706
|
|
|
1705
1707
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-defaultdimensionvalue
|
|
1706
1708
|
'''
|
|
@@ -1712,10 +1714,10 @@ class CfnConfigurationSetEventDestination(
|
|
|
1712
1714
|
def dimension_name(self) -> builtins.str:
|
|
1713
1715
|
'''The name of an Amazon CloudWatch dimension associated with an email sending metric.
|
|
1714
1716
|
|
|
1715
|
-
The name
|
|
1717
|
+
The name has to meet the following criteria:
|
|
1716
1718
|
|
|
1717
|
-
-
|
|
1718
|
-
-
|
|
1719
|
+
- It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).
|
|
1720
|
+
- It can contain no more than 256 characters.
|
|
1719
1721
|
|
|
1720
1722
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionname
|
|
1721
1723
|
'''
|
|
@@ -1725,9 +1727,9 @@ class CfnConfigurationSetEventDestination(
|
|
|
1725
1727
|
|
|
1726
1728
|
@builtins.property
|
|
1727
1729
|
def dimension_value_source(self) -> builtins.str:
|
|
1728
|
-
'''The
|
|
1730
|
+
'''The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch.
|
|
1729
1731
|
|
|
1730
|
-
To use the message tags that you specify using an ``X-SES-MESSAGE-TAGS`` header or a parameter to the ``SendEmail``
|
|
1732
|
+
To use the message tags that you specify using an ``X-SES-MESSAGE-TAGS`` header or a parameter to the ``SendEmail`` or ``SendRawEmail`` API, choose ``messageTag`` . To use your own email headers, choose ``emailHeader`` . To use link tags, choose ``linkTag`` .
|
|
1731
1733
|
|
|
1732
1734
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-dimensionconfiguration.html#cfn-ses-configurationseteventdestination-dimensionconfiguration-dimensionvaluesource
|
|
1733
1735
|
'''
|
|
@@ -1753,9 +1755,11 @@ class CfnConfigurationSetEventDestination(
|
|
|
1753
1755
|
)
|
|
1754
1756
|
class EventBridgeDestinationProperty:
|
|
1755
1757
|
def __init__(self, *, event_bus_arn: builtins.str) -> None:
|
|
1756
|
-
'''An object that
|
|
1758
|
+
'''An object that defines an Amazon EventBridge destination for email events.
|
|
1759
|
+
|
|
1760
|
+
You can use Amazon EventBridge to send notifications when certain email events occur.
|
|
1757
1761
|
|
|
1758
|
-
:param event_bus_arn:
|
|
1762
|
+
:param event_bus_arn: The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported.
|
|
1759
1763
|
|
|
1760
1764
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventbridgedestination.html
|
|
1761
1765
|
:exampleMetadata: fixture=_generated
|
|
@@ -1779,7 +1783,10 @@ class CfnConfigurationSetEventDestination(
|
|
|
1779
1783
|
|
|
1780
1784
|
@builtins.property
|
|
1781
1785
|
def event_bus_arn(self) -> builtins.str:
|
|
1782
|
-
'''
|
|
1786
|
+
'''The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to.
|
|
1787
|
+
|
|
1788
|
+
Only the default bus is supported.
|
|
1789
|
+
|
|
1783
1790
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventbridgedestination.html#cfn-ses-configurationseteventdestination-eventbridgedestination-eventbusarn
|
|
1784
1791
|
'''
|
|
1785
1792
|
result = self._values.get("event_bus_arn")
|
|
@@ -1822,18 +1829,14 @@ class CfnConfigurationSetEventDestination(
|
|
|
1822
1829
|
name: typing.Optional[builtins.str] = None,
|
|
1823
1830
|
sns_destination: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnConfigurationSetEventDestination.SnsDestinationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
1824
1831
|
) -> None:
|
|
1825
|
-
'''
|
|
1826
|
-
|
|
1827
|
-
.. epigraph::
|
|
1832
|
+
'''In the Amazon SES API v2, *events* include message sends, deliveries, opens, clicks, bounces, complaints and delivery delays.
|
|
1828
1833
|
|
|
1829
|
-
|
|
1834
|
+
*Event destinations* are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.
|
|
1830
1835
|
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
:param
|
|
1834
|
-
:param
|
|
1835
|
-
:param enabled: Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to ``true`` to enable publishing to this destination; set to ``false`` to prevent publishing to this destination. The default value is ``false`` .
|
|
1836
|
-
:param event_bridge_destination: An object that contains Event bus ARN associated with the event bridge destination.
|
|
1836
|
+
:param matching_event_types: The types of events that Amazon SES sends to the specified event destinations. - ``SEND`` - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.) - ``REJECT`` - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server. - ``BOUNCE`` - ( *Hard bounce* ) The recipient's mail server permanently rejected the email. ( *Soft bounces* are only included when SES fails to deliver the email after retrying for a period of time.) - ``COMPLAINT`` - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam. - ``DELIVERY`` - SES successfully delivered the email to the recipient's mail server. - ``OPEN`` - The recipient received the message and opened it in their email client. - ``CLICK`` - The recipient clicked one or more links in the email. - ``RENDERING_FAILURE`` - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the ```SendTemplatedEmail`` <https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html>`_ or ```SendBulkTemplatedEmail`` <https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html>`_ API operations.) - ``DELIVERY_DELAY`` - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue. - ``SUBSCRIPTION`` - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an *unsubscribe* link as part of your `subscription management <https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html>`_ .
|
|
1837
|
+
:param cloud_watch_destination: An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
|
|
1838
|
+
:param enabled: If ``true`` , the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this ``EventDestinationDefinition`` . If ``false`` , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
|
|
1839
|
+
:param event_bridge_destination: An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur.
|
|
1837
1840
|
:param kinesis_firehose_destination: An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.
|
|
1838
1841
|
:param name: The name of the event destination. The name must meet the following requirements:. - Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer.
|
|
1839
1842
|
:param sns_destination: An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.
|
|
@@ -1899,18 +1902,18 @@ class CfnConfigurationSetEventDestination(
|
|
|
1899
1902
|
|
|
1900
1903
|
@builtins.property
|
|
1901
1904
|
def matching_event_types(self) -> typing.List[builtins.str]:
|
|
1902
|
-
'''The
|
|
1903
|
-
|
|
1904
|
-
- ``
|
|
1905
|
-
- ``
|
|
1906
|
-
- ``
|
|
1907
|
-
- ``
|
|
1908
|
-
- ``
|
|
1909
|
-
- ``
|
|
1910
|
-
- ``
|
|
1911
|
-
- ``
|
|
1912
|
-
- ``
|
|
1913
|
-
- ``
|
|
1905
|
+
'''The types of events that Amazon SES sends to the specified event destinations.
|
|
1906
|
+
|
|
1907
|
+
- ``SEND`` - The send request was successful and SES will attempt to deliver the message to the recipient’s mail server. (If account-level or global suppression is being used, SES will still count it as a send, but delivery is suppressed.)
|
|
1908
|
+
- ``REJECT`` - SES accepted the email, but determined that it contained a virus and didn’t attempt to deliver it to the recipient’s mail server.
|
|
1909
|
+
- ``BOUNCE`` - ( *Hard bounce* ) The recipient's mail server permanently rejected the email. ( *Soft bounces* are only included when SES fails to deliver the email after retrying for a period of time.)
|
|
1910
|
+
- ``COMPLAINT`` - The email was successfully delivered to the recipient’s mail server, but the recipient marked it as spam.
|
|
1911
|
+
- ``DELIVERY`` - SES successfully delivered the email to the recipient's mail server.
|
|
1912
|
+
- ``OPEN`` - The recipient received the message and opened it in their email client.
|
|
1913
|
+
- ``CLICK`` - The recipient clicked one or more links in the email.
|
|
1914
|
+
- ``RENDERING_FAILURE`` - The email wasn't sent because of a template rendering issue. This event type can occur when template data is missing, or when there is a mismatch between template parameters and data. (This event type only occurs when you send email using the ```SendTemplatedEmail`` <https://docs.aws.amazon.com/ses/latest/APIReference/API_SendTemplatedEmail.html>`_ or ```SendBulkTemplatedEmail`` <https://docs.aws.amazon.com/ses/latest/APIReference/API_SendBulkTemplatedEmail.html>`_ API operations.)
|
|
1915
|
+
- ``DELIVERY_DELAY`` - The email couldn't be delivered to the recipient’s mail server because a temporary issue occurred. Delivery delays can occur, for example, when the recipient's inbox is full, or when the receiving email server experiences a transient issue.
|
|
1916
|
+
- ``SUBSCRIPTION`` - The email was successfully delivered, but the recipient updated their subscription preferences by clicking on an *unsubscribe* link as part of your `subscription management <https://docs.aws.amazon.com/ses/latest/dg/sending-email-subscription-management.html>`_ .
|
|
1914
1917
|
|
|
1915
1918
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-matchingeventtypes
|
|
1916
1919
|
'''
|
|
@@ -1922,7 +1925,9 @@ class CfnConfigurationSetEventDestination(
|
|
|
1922
1925
|
def cloud_watch_destination(
|
|
1923
1926
|
self,
|
|
1924
1927
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSetEventDestination.CloudWatchDestinationProperty"]]:
|
|
1925
|
-
'''An object that
|
|
1928
|
+
'''An object that defines an Amazon CloudWatch destination for email events.
|
|
1929
|
+
|
|
1930
|
+
You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.
|
|
1926
1931
|
|
|
1927
1932
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-cloudwatchdestination
|
|
1928
1933
|
'''
|
|
@@ -1933,9 +1938,11 @@ class CfnConfigurationSetEventDestination(
|
|
|
1933
1938
|
def enabled(
|
|
1934
1939
|
self,
|
|
1935
1940
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
1936
|
-
'''
|
|
1941
|
+
'''If ``true`` , the event destination is enabled.
|
|
1942
|
+
|
|
1943
|
+
When the event destination is enabled, the specified event types are sent to the destinations in this ``EventDestinationDefinition`` .
|
|
1937
1944
|
|
|
1938
|
-
|
|
1945
|
+
If ``false`` , the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.
|
|
1939
1946
|
|
|
1940
1947
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-enabled
|
|
1941
1948
|
'''
|
|
@@ -1946,7 +1953,9 @@ class CfnConfigurationSetEventDestination(
|
|
|
1946
1953
|
def event_bridge_destination(
|
|
1947
1954
|
self,
|
|
1948
1955
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnConfigurationSetEventDestination.EventBridgeDestinationProperty"]]:
|
|
1949
|
-
'''An object that
|
|
1956
|
+
'''An object that defines an Amazon EventBridge destination for email events.
|
|
1957
|
+
|
|
1958
|
+
You can use Amazon EventBridge to send notifications when certain email events occur.
|
|
1950
1959
|
|
|
1951
1960
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-eventdestination.html#cfn-ses-configurationseteventdestination-eventdestination-eventbridgedestination
|
|
1952
1961
|
'''
|
|
@@ -2013,12 +2022,12 @@ class CfnConfigurationSetEventDestination(
|
|
|
2013
2022
|
delivery_stream_arn: builtins.str,
|
|
2014
2023
|
iam_role_arn: builtins.str,
|
|
2015
2024
|
) -> None:
|
|
2016
|
-
'''
|
|
2025
|
+
'''An object that defines an Amazon Kinesis Data Firehose destination for email events.
|
|
2017
2026
|
|
|
2018
|
-
|
|
2027
|
+
You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.
|
|
2019
2028
|
|
|
2020
2029
|
:param delivery_stream_arn: The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.
|
|
2021
|
-
:param iam_role_arn: The ARN of the IAM role
|
|
2030
|
+
:param iam_role_arn: The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
|
|
2022
2031
|
|
|
2023
2032
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html
|
|
2024
2033
|
:exampleMetadata: fixture=_generated
|
|
@@ -2055,7 +2064,7 @@ class CfnConfigurationSetEventDestination(
|
|
|
2055
2064
|
|
|
2056
2065
|
@builtins.property
|
|
2057
2066
|
def iam_role_arn(self) -> builtins.str:
|
|
2058
|
-
'''The ARN of the IAM role
|
|
2067
|
+
'''The Amazon Resource Name (ARN) of the IAM role that the Amazon SES API v2 uses to send email events to the Amazon Kinesis Data Firehose stream.
|
|
2059
2068
|
|
|
2060
2069
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-configurationseteventdestination-kinesisfirehosedestination.html#cfn-ses-configurationseteventdestination-kinesisfirehosedestination-iamrolearn
|
|
2061
2070
|
'''
|
|
@@ -2151,7 +2160,7 @@ class CfnConfigurationSetEventDestinationProps:
|
|
|
2151
2160
|
'''Properties for defining a ``CfnConfigurationSetEventDestination``.
|
|
2152
2161
|
|
|
2153
2162
|
:param configuration_set_name: The name of the configuration set that contains the event destination.
|
|
2154
|
-
:param event_destination:
|
|
2163
|
+
:param event_destination: An object that defines the event destination.
|
|
2155
2164
|
|
|
2156
2165
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html
|
|
2157
2166
|
:exampleMetadata: fixture=_generated
|
|
@@ -2213,7 +2222,7 @@ class CfnConfigurationSetEventDestinationProps:
|
|
|
2213
2222
|
def event_destination(
|
|
2214
2223
|
self,
|
|
2215
2224
|
) -> typing.Union[_IResolvable_da3f097b, CfnConfigurationSetEventDestination.EventDestinationProperty]:
|
|
2216
|
-
'''
|
|
2225
|
+
'''An object that defines the event destination.
|
|
2217
2226
|
|
|
2218
2227
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationseteventdestination.html#cfn-ses-configurationseteventdestination-eventdestination
|
|
2219
2228
|
'''
|
|
@@ -2260,12 +2269,12 @@ class CfnConfigurationSetProps:
|
|
|
2260
2269
|
) -> None:
|
|
2261
2270
|
'''Properties for defining a ``CfnConfigurationSet``.
|
|
2262
2271
|
|
|
2263
|
-
:param delivery_options: Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
|
2272
|
+
:param delivery_options: Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
|
2264
2273
|
:param name: The name of the configuration set. The name must meet the following requirements:. - Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). - Contain 64 characters or fewer.
|
|
2265
|
-
:param reputation_options: An object that
|
|
2274
|
+
:param reputation_options: An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
|
|
2266
2275
|
:param sending_options: An object that defines whether or not Amazon SES can send email that you send using the configuration set.
|
|
2267
2276
|
:param suppression_options: An object that contains information about the suppression list preferences for your account.
|
|
2268
|
-
:param tracking_options:
|
|
2277
|
+
:param tracking_options: An object that defines the open and click tracking options for emails that you send using the configuration set.
|
|
2269
2278
|
:param vdm_options: The Virtual Deliverability Manager (VDM) options that apply to the configuration set.
|
|
2270
2279
|
|
|
2271
2280
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html
|
|
@@ -2334,7 +2343,7 @@ class CfnConfigurationSetProps:
|
|
|
2334
2343
|
def delivery_options(
|
|
2335
2344
|
self,
|
|
2336
2345
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnConfigurationSet.DeliveryOptionsProperty]]:
|
|
2337
|
-
'''Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
|
2346
|
+
'''Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).
|
|
2338
2347
|
|
|
2339
2348
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-deliveryoptions
|
|
2340
2349
|
'''
|
|
@@ -2357,7 +2366,7 @@ class CfnConfigurationSetProps:
|
|
|
2357
2366
|
def reputation_options(
|
|
2358
2367
|
self,
|
|
2359
2368
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnConfigurationSet.ReputationOptionsProperty]]:
|
|
2360
|
-
'''An object that
|
|
2369
|
+
'''An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
|
|
2361
2370
|
|
|
2362
2371
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-reputationoptions
|
|
2363
2372
|
'''
|
|
@@ -2390,7 +2399,7 @@ class CfnConfigurationSetProps:
|
|
|
2390
2399
|
def tracking_options(
|
|
2391
2400
|
self,
|
|
2392
2401
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnConfigurationSet.TrackingOptionsProperty]]:
|
|
2393
|
-
'''
|
|
2402
|
+
'''An object that defines the open and click tracking options for emails that you send using the configuration set.
|
|
2394
2403
|
|
|
2395
2404
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-configurationset.html#cfn-ses-configurationset-trackingoptions
|
|
2396
2405
|
'''
|
|
@@ -3020,9 +3029,9 @@ class CfnEmailIdentity(
|
|
|
3020
3029
|
|
|
3021
3030
|
An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.
|
|
3022
3031
|
|
|
3023
|
-
When you verify an email address, SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain without specifying the DkimSigningAttributes properties, OR only the NextSigningKeyLength property of DkimSigningAttributes, this resource provides a set of CNAME token names and values (DkimDNSTokenName1, DkimDNSTokenValue1, DkimDNSTokenName2, DkimDNSTokenValue2, DkimDNSTokenName3, DkimDNSTokenValue3) as outputs. You can then add these to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.
|
|
3032
|
+
When you verify an email address, SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain without specifying the ``DkimSigningAttributes`` properties, OR only the ``NextSigningKeyLength`` property of ``DkimSigningAttributes`` , this resource provides a set of CNAME token names and values ( *DkimDNSTokenName1* , *DkimDNSTokenValue1* , *DkimDNSTokenName2* , *DkimDNSTokenValue2* , *DkimDNSTokenName3* , *DkimDNSTokenValue3* ) as outputs. You can then add these to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.
|
|
3024
3033
|
|
|
3025
|
-
Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your resource must include DkimSigningAttributes properties DomainSigningSelector and DomainSigningPrivateKey. When you specify this object, you provide a selector (DomainSigningSelector) (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key (DomainSigningPrivateKey).
|
|
3034
|
+
Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your resource must include ``DkimSigningAttributes`` properties ``DomainSigningSelector`` and ``DomainSigningPrivateKey`` . When you specify this object, you provide a selector ( ``DomainSigningSelector`` ) (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key ( ``DomainSigningPrivateKey`` ).
|
|
3026
3035
|
|
|
3027
3036
|
Additionally, you can associate an existing configuration set with the email identity that you're verifying.
|
|
3028
3037
|
|
|
@@ -3079,7 +3088,7 @@ class CfnEmailIdentity(
|
|
|
3079
3088
|
:param email_identity: The email address or domain to verify.
|
|
3080
3089
|
:param configuration_set_attributes: Used to associate a configuration set with an email identity.
|
|
3081
3090
|
:param dkim_attributes: An object that contains information about the DKIM attributes for the identity.
|
|
3082
|
-
:param dkim_signing_attributes: If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for `Easy DKIM <https://docs.aws.amazon.com/ses/latest/
|
|
3091
|
+
:param dkim_signing_attributes: If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for `Easy DKIM <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html>`_ . You can only specify this object if the email identity is a domain, as opposed to an address.
|
|
3083
3092
|
:param feedback_attributes: Used to enable or disable feedback forwarding for an identity.
|
|
3084
3093
|
:param mail_from_attributes: Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
|
3085
3094
|
'''
|
|
@@ -3241,7 +3250,7 @@ class CfnEmailIdentity(
|
|
|
3241
3250
|
def dkim_signing_attributes(
|
|
3242
3251
|
self,
|
|
3243
3252
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEmailIdentity.DkimSigningAttributesProperty"]]:
|
|
3244
|
-
'''If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for `Easy DKIM <https://docs.aws.amazon.com/ses/latest/
|
|
3253
|
+
'''If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for `Easy DKIM <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html>`_ .'''
|
|
3245
3254
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnEmailIdentity.DkimSigningAttributesProperty"]], jsii.get(self, "dkimSigningAttributes"))
|
|
3246
3255
|
|
|
3247
3256
|
@dkim_signing_attributes.setter
|
|
@@ -3690,7 +3699,7 @@ class CfnEmailIdentityProps:
|
|
|
3690
3699
|
:param email_identity: The email address or domain to verify.
|
|
3691
3700
|
:param configuration_set_attributes: Used to associate a configuration set with an email identity.
|
|
3692
3701
|
:param dkim_attributes: An object that contains information about the DKIM attributes for the identity.
|
|
3693
|
-
:param dkim_signing_attributes: If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for `Easy DKIM <https://docs.aws.amazon.com/ses/latest/
|
|
3702
|
+
:param dkim_signing_attributes: If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for `Easy DKIM <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html>`_ . You can only specify this object if the email identity is a domain, as opposed to an address.
|
|
3694
3703
|
:param feedback_attributes: Used to enable or disable feedback forwarding for an identity.
|
|
3695
3704
|
:param mail_from_attributes: Used to enable or disable the custom Mail-From domain configuration for an email identity.
|
|
3696
3705
|
|
|
@@ -3785,7 +3794,9 @@ class CfnEmailIdentityProps:
|
|
|
3785
3794
|
def dkim_signing_attributes(
|
|
3786
3795
|
self,
|
|
3787
3796
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnEmailIdentity.DkimSigningAttributesProperty]]:
|
|
3788
|
-
'''If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for `Easy DKIM <https://docs.aws.amazon.com/ses/latest/
|
|
3797
|
+
'''If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for `Easy DKIM <https://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html>`_ .
|
|
3798
|
+
|
|
3799
|
+
You can only specify this object if the email identity is a domain, as opposed to an address.
|
|
3789
3800
|
|
|
3790
3801
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimsigningattributes
|
|
3791
3802
|
'''
|
|
@@ -4389,7 +4400,7 @@ class CfnReceiptRule(
|
|
|
4389
4400
|
:param s3_action: Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.
|
|
4390
4401
|
:param sns_action: Publishes the email content within a notification to Amazon SNS.
|
|
4391
4402
|
:param stop_action: Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.
|
|
4392
|
-
:param workmail_action: Calls Amazon WorkMail and, optionally, publishes a notification to Amazon
|
|
4403
|
+
:param workmail_action: Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
|
|
4393
4404
|
|
|
4394
4405
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html
|
|
4395
4406
|
:exampleMetadata: fixture=_generated
|
|
@@ -4542,7 +4553,7 @@ class CfnReceiptRule(
|
|
|
4542
4553
|
def workmail_action(
|
|
4543
4554
|
self,
|
|
4544
4555
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnReceiptRule.WorkmailActionProperty"]]:
|
|
4545
|
-
'''Calls Amazon WorkMail and, optionally, publishes a notification to Amazon
|
|
4556
|
+
'''Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.
|
|
4546
4557
|
|
|
4547
4558
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-action.html#cfn-ses-receiptrule-action-workmailaction
|
|
4548
4559
|
'''
|
|
@@ -4574,9 +4585,9 @@ class CfnReceiptRule(
|
|
|
4574
4585
|
) -> None:
|
|
4575
4586
|
'''When included in a receipt rule, this action adds a header to the received email.
|
|
4576
4587
|
|
|
4577
|
-
For information about adding a header using a receipt rule, see the `Amazon SES Developer Guide <https://docs.aws.amazon.com/ses/latest/dg/receiving-email-
|
|
4588
|
+
For information about adding a header using a receipt rule, see the `Amazon SES Developer Guide <https://docs.aws.amazon.com/ses/latest/dg/receiving-email-receipt-rules-console-walkthrough.html>`_ .
|
|
4578
4589
|
|
|
4579
|
-
:param header_name: The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
|
|
4590
|
+
:param header_name: The name of the header to add to the incoming message. The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric ( ``a–z, A–Z, 0–9`` ) characters and dashes.
|
|
4580
4591
|
:param header_value: The content to include in the header. This value can contain up to 2048 characters. It can't contain newline ( ``\\n`` ) or carriage return ( ``\\r`` ) characters.
|
|
4581
4592
|
|
|
4582
4593
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html
|
|
@@ -4606,7 +4617,7 @@ class CfnReceiptRule(
|
|
|
4606
4617
|
def header_name(self) -> builtins.str:
|
|
4607
4618
|
'''The name of the header to add to the incoming message.
|
|
4608
4619
|
|
|
4609
|
-
The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric (a–z, A–Z, 0–9) characters and dashes.
|
|
4620
|
+
The name must contain at least one character, and can contain up to 50 characters. It consists of alphanumeric ( ``a–z, A–Z, 0–9`` ) characters and dashes.
|
|
4610
4621
|
|
|
4611
4622
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-receiptrule-addheaderaction.html#cfn-ses-receiptrule-addheaderaction-headername
|
|
4612
4623
|
'''
|
|
@@ -5106,7 +5117,7 @@ class CfnReceiptRule(
|
|
|
5106
5117
|
To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about granting permissions, see the `Amazon SES Developer Guide <https://docs.aws.amazon.com/ses/latest/dg/receiving-email-permissions.html>`_ .
|
|
5107
5118
|
.. epigraph::
|
|
5108
5119
|
|
|
5109
|
-
When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is
|
|
5120
|
+
When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 30 MB. Emails larger than that bounces.
|
|
5110
5121
|
|
|
5111
5122
|
For information about specifying Amazon S3 actions in receipt rules, see the `Amazon SES Developer Guide <https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-s3.html>`_ .
|
|
5112
5123
|
|
|
@@ -5647,7 +5658,7 @@ class CfnReceiptRuleSet(
|
|
|
5647
5658
|
'''
|
|
5648
5659
|
:param scope: Scope in which this resource is defined.
|
|
5649
5660
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
5650
|
-
:param rule_set_name: The name of the receipt rule set to
|
|
5661
|
+
:param rule_set_name: The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
|
|
5651
5662
|
'''
|
|
5652
5663
|
if __debug__:
|
|
5653
5664
|
type_hints = typing.get_type_hints(_typecheckingstub__c8e8c05ea09aa8fb4e787d2e45cbe7d16eaf164f24c154797b3e350dd0b5316c)
|
|
@@ -5703,7 +5714,7 @@ class CfnReceiptRuleSet(
|
|
|
5703
5714
|
@builtins.property
|
|
5704
5715
|
@jsii.member(jsii_name="ruleSetName")
|
|
5705
5716
|
def rule_set_name(self) -> typing.Optional[builtins.str]:
|
|
5706
|
-
'''The name of the receipt rule set to
|
|
5717
|
+
'''The name of the receipt rule set to make active.'''
|
|
5707
5718
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "ruleSetName"))
|
|
5708
5719
|
|
|
5709
5720
|
@rule_set_name.setter
|
|
@@ -5723,7 +5734,7 @@ class CfnReceiptRuleSetProps:
|
|
|
5723
5734
|
def __init__(self, *, rule_set_name: typing.Optional[builtins.str] = None) -> None:
|
|
5724
5735
|
'''Properties for defining a ``CfnReceiptRuleSet``.
|
|
5725
5736
|
|
|
5726
|
-
:param rule_set_name: The name of the receipt rule set to
|
|
5737
|
+
:param rule_set_name: The name of the receipt rule set to make active. Setting this value to null disables all email receiving.
|
|
5727
5738
|
|
|
5728
5739
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html
|
|
5729
5740
|
:exampleMetadata: fixture=_generated
|
|
@@ -5747,7 +5758,9 @@ class CfnReceiptRuleSetProps:
|
|
|
5747
5758
|
|
|
5748
5759
|
@builtins.property
|
|
5749
5760
|
def rule_set_name(self) -> typing.Optional[builtins.str]:
|
|
5750
|
-
'''The name of the receipt rule set to
|
|
5761
|
+
'''The name of the receipt rule set to make active.
|
|
5762
|
+
|
|
5763
|
+
Setting this value to null disables all email receiving.
|
|
5751
5764
|
|
|
5752
5765
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptruleset.html#cfn-ses-receiptruleset-rulesetname
|
|
5753
5766
|
'''
|
|
@@ -5898,11 +5911,13 @@ class CfnTemplate(
|
|
|
5898
5911
|
template_name: typing.Optional[builtins.str] = None,
|
|
5899
5912
|
text_part: typing.Optional[builtins.str] = None,
|
|
5900
5913
|
) -> None:
|
|
5901
|
-
'''
|
|
5914
|
+
'''An object that defines the email template to use for an email message, and the values to use for any message variables in that template.
|
|
5915
|
+
|
|
5916
|
+
An *email template* is a type of message template that contains content that you want to define, save, and reuse in email messages that you send.
|
|
5902
5917
|
|
|
5903
5918
|
:param subject_part: The subject line of the email.
|
|
5904
5919
|
:param html_part: The HTML body of the email.
|
|
5905
|
-
:param template_name: The name of the template.
|
|
5920
|
+
:param template_name: The name of the template. You will refer to this name when you send email using the ``SendTemplatedEmail`` or ``SendBulkTemplatedEmail`` operations.
|
|
5906
5921
|
:param text_part: The email body that is visible to recipients whose email clients do not display HTML content.
|
|
5907
5922
|
|
|
5908
5923
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html
|
|
@@ -5962,6 +5977,8 @@ class CfnTemplate(
|
|
|
5962
5977
|
def template_name(self) -> typing.Optional[builtins.str]:
|
|
5963
5978
|
'''The name of the template.
|
|
5964
5979
|
|
|
5980
|
+
You will refer to this name when you send email using the ``SendTemplatedEmail`` or ``SendBulkTemplatedEmail`` operations.
|
|
5981
|
+
|
|
5965
5982
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-template-template.html#cfn-ses-template-template-templatename
|
|
5966
5983
|
'''
|
|
5967
5984
|
result = self._values.get("template_name")
|
|
@@ -6197,7 +6214,7 @@ class CfnVdmAttributes(
|
|
|
6197
6214
|
*,
|
|
6198
6215
|
engagement_metrics: typing.Optional[builtins.str] = None,
|
|
6199
6216
|
) -> None:
|
|
6200
|
-
'''
|
|
6217
|
+
'''An object containing additional settings for your VDM configuration as applicable to the Dashboard.
|
|
6201
6218
|
|
|
6202
6219
|
:param engagement_metrics: Specifies the status of your VDM engagement metrics collection. Can be one of the following:. - ``ENABLED`` – Amazon SES enables engagement metrics for your account. - ``DISABLED`` – Amazon SES disables engagement metrics for your account.
|
|
6203
6220
|
|
|
@@ -6255,7 +6272,7 @@ class CfnVdmAttributes(
|
|
|
6255
6272
|
*,
|
|
6256
6273
|
optimized_shared_delivery: typing.Optional[builtins.str] = None,
|
|
6257
6274
|
) -> None:
|
|
6258
|
-
'''
|
|
6275
|
+
'''An object containing additional settings for your VDM configuration as applicable to the Guardian.
|
|
6259
6276
|
|
|
6260
6277
|
:param optimized_shared_delivery: Specifies the status of your VDM optimized shared delivery. Can be one of the following:. - ``ENABLED`` – Amazon SES enables optimized shared delivery for your account. - ``DISABLED`` – Amazon SES disables optimized shared delivery for your account.
|
|
6261
6278
|
|