aws-cdk-lib 2.138.0__py3-none-any.whl → 2.139.0__py3-none-any.whl

aws_cdk/aws_ses_actions/__init__.py

@@ -11,6 +11,7 @@ Currently supported are:
 * [Lambda](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-lambda.html)
 * [S3](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-s3.html)
 * [SNS](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-sns.html)
+* [WorkMail](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-workmail.html)
 * [Stop](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html)
 
 See the README of `aws-cdk-lib/aws-ses` for more information.
@@ -1122,6 +1123,144 @@ class StopProps:
         )
 
 
+@jsii.implements(_IReceiptRuleAction_941d7a8d)
+class WorkMail(
+    metaclass=jsii.JSIIMeta,
+    jsii_type="aws-cdk-lib.aws_ses_actions.WorkMail",
+):
+    '''Integrates an Amazon WorkMail action into a receipt rule set, and optionally publishes a notification to Amazon SNS.
+
+    Beware that WorkMail should already set up an active ``INBOUND_MAIL`` rule set
+    that includes a WorkMail rule action for this exact purpose.
+    This action should be used to customize the behavior of replacement rule set.
+
+    :see: https://docs.aws.amazon.com/ses/latest/dg/receiving-email-action-workmail.html
+    :exampleMetadata: fixture=_generated
+
+    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_ses_actions as ses_actions
+        from aws_cdk import aws_sns as sns
+        
+        # topic: sns.Topic
+        
+        work_mail = ses_actions.WorkMail(
+            organization_arn="organizationArn",
+        
+            # the properties below are optional
+            topic=topic
+        )
+    '''
+
+    def __init__(
+        self,
+        *,
+        organization_arn: builtins.str,
+        topic: typing.Optional[_ITopic_9eca4852] = None,
+    ) -> None:
+        '''
+        :param organization_arn: The WorkMail organization ARN. Amazon WorkMail organization ARNs are in the form ``arn:aws:workmail:region:account_ID:organization/organization_ID``
+        :param topic: The SNS topic to notify when the WorkMail action is taken. Default: - no topic will be attached to the action
+        '''
+        props = WorkMailProps(organization_arn=organization_arn, topic=topic)
+
+        jsii.create(self.__class__, self, [props])
+
+    @jsii.member(jsii_name="bind")
+    def bind(self, _rule: _IReceiptRule_20f5161a) -> _ReceiptRuleActionConfig_6feb97ed:
+        '''Returns the receipt rule action specification.
+
+        :param _rule: -
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__8f080cf4ee15d472001a0397f98592fa7c3d2f44cc23e0af0b37e2d22590adb8)
+            check_type(argname="argument _rule", value=_rule, expected_type=type_hints["_rule"])
+        return typing.cast(_ReceiptRuleActionConfig_6feb97ed, jsii.invoke(self, "bind", [_rule]))
+
+
+@jsii.data_type(
+    jsii_type="aws-cdk-lib.aws_ses_actions.WorkMailProps",
+    jsii_struct_bases=[],
+    name_mapping={"organization_arn": "organizationArn", "topic": "topic"},
+)
+class WorkMailProps:
+    def __init__(
+        self,
+        *,
+        organization_arn: builtins.str,
+        topic: typing.Optional[_ITopic_9eca4852] = None,
+    ) -> None:
+        '''Construction properties for a WorkMail action.
+
+        :param organization_arn: The WorkMail organization ARN. Amazon WorkMail organization ARNs are in the form ``arn:aws:workmail:region:account_ID:organization/organization_ID``
+        :param topic: The SNS topic to notify when the WorkMail action is taken. Default: - no topic will be attached to the action
+
+        :exampleMetadata: fixture=_generated
+
+        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_ses_actions as ses_actions
+            from aws_cdk import aws_sns as sns
+            
+            # topic: sns.Topic
+            
+            work_mail_props = ses_actions.WorkMailProps(
+                organization_arn="organizationArn",
+            
+                # the properties below are optional
+                topic=topic
+            )
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__a0399d4e0f3bee3c7826f6038a069221acf83ae5060ede7c972898e0e1424b20)
+            check_type(argname="argument organization_arn", value=organization_arn, expected_type=type_hints["organization_arn"])
+            check_type(argname="argument topic", value=topic, expected_type=type_hints["topic"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {
+            "organization_arn": organization_arn,
+        }
+        if topic is not None:
+            self._values["topic"] = topic
+
+    @builtins.property
+    def organization_arn(self) -> builtins.str:
+        '''The WorkMail organization ARN.
+
+        Amazon WorkMail organization ARNs are in the form
+        ``arn:aws:workmail:region:account_ID:organization/organization_ID``
+
+        Example::
+
+            "arn:aws:workmail:us-east-1:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7"
+        '''
+        result = self._values.get("organization_arn")
+        assert result is not None, "Required property 'organization_arn' is missing"
+        return typing.cast(builtins.str, result)
+
+    @builtins.property
+    def topic(self) -> typing.Optional[_ITopic_9eca4852]:
+        '''The SNS topic to notify when the WorkMail action is taken.
+
+        :default: - no topic will be attached to the action
+        '''
+        result = self._values.get("topic")
+        return typing.cast(typing.Optional[_ITopic_9eca4852], result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "WorkMailProps(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
 __all__ = [
     "AddHeader",
     "AddHeaderProps",
@@ -1139,6 +1278,8 @@ __all__ = [
     "SnsProps",
     "Stop",
     "StopProps",
+    "WorkMail",
+    "WorkMailProps",
 ]
 
 publication.publish()
@@ -1238,3 +1379,17 @@ def _typecheckingstub__73591009ec257744526587f77beba227d032486c4c60371ab35e8f381
 ) -> None:
     """Type checking stubs"""
     pass
+
+def _typecheckingstub__8f080cf4ee15d472001a0397f98592fa7c3d2f44cc23e0af0b37e2d22590adb8(
+    _rule: _IReceiptRule_20f5161a,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__a0399d4e0f3bee3c7826f6038a069221acf83ae5060ede7c972898e0e1424b20(
+    *,
+    organization_arn: builtins.str,
+    topic: typing.Optional[_ITopic_9eca4852] = None,
+) -> None:
+    """Type checking stubs"""
+    pass

aws_cdk/aws_ssm/__init__.py

@@ -1250,7 +1250,7 @@ class CfnDocument(
         :param attachments: A list of key-value pairs that describe attachments to a version of a document.
         :param document_format: Specify the document format for the request. ``JSON`` is the default format. Default: - "JSON"
         :param document_type: The type of document to create.
-        :param name: A name for the SSM document. .. epigraph:: You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: - ``aws`` - ``amazon`` - ``amzn``
+        :param name: A name for the SSM document. .. epigraph:: You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: - ``aws`` - ``amazon`` - ``amzn`` - ``AWSEC2`` - ``AWSConfigRemediation`` - ``AWSSupport``
         :param requires: A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ``ApplicationConfiguration`` document requires an ``ApplicationConfigurationSchema`` document for validation purposes. For more information, see `What is AWS AppConfig ? <https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html>`_ in the *AWS AppConfig User Guide* .
         :param tags: AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.
         :param target_type: Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: ``/AWS::EC2::Instance`` . If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see `AWS resource and property types reference <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html>`_ in the *AWS CloudFormation User Guide* .
@@ -1670,7 +1670,7 @@ class CfnDocumentProps:
         :param attachments: A list of key-value pairs that describe attachments to a version of a document.
         :param document_format: Specify the document format for the request. ``JSON`` is the default format. Default: - "JSON"
         :param document_type: The type of document to create.
-        :param name: A name for the SSM document. .. epigraph:: You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: - ``aws`` - ``amazon`` - ``amzn``
+        :param name: A name for the SSM document. .. epigraph:: You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes: - ``aws`` - ``amazon`` - ``amzn`` - ``AWSEC2`` - ``AWSConfigRemediation`` - ``AWSSupport``
         :param requires: A list of SSM documents required by a document. This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ``ApplicationConfiguration`` document requires an ``ApplicationConfigurationSchema`` document for validation purposes. For more information, see `What is AWS AppConfig ? <https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html>`_ in the *AWS AppConfig User Guide* .
         :param tags: AWS CloudFormation resource tags to apply to the document. Use tags to help you identify and categorize resources.
         :param target_type: Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: ``/AWS::EC2::Instance`` . If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see `AWS resource and property types reference <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html>`_ in the *AWS CloudFormation User Guide* .
@@ -1806,6 +1806,9 @@ class CfnDocumentProps:
            - ``aws``
            - ``amazon``
            - ``amzn``
+           - ``AWSEC2``
+           - ``AWSConfigRemediation``
+           - ``AWSSupport``
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name
         '''