ReceiptRuleActionConfig

class aws_cdk.aws_ses.ReceiptRuleActionConfig(*, add_header_action=None, bounce_action=None, lambda_action=None, s3_action=None, sns_action=None, stop_action=None, workmail_action=None)

Bases: object

Properties for a receipt rule action.

Parameters
  • add_header_action (Union[AddHeaderActionConfig, Dict[str, Any], None]) – Adds a header to the received email.

  • bounce_action (Union[BounceActionConfig, Dict[str, Any], None]) – Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.

  • lambda_action (Union[LambdaActionConfig, Dict[str, Any], None]) – Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

  • s3_action (Union[S3ActionConfig, Dict[str, Any], None]) – Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.

  • sns_action (Union[SNSActionConfig, Dict[str, Any], None]) – Publishes the email content within a notification to Amazon SNS.

  • stop_action (Union[StopActionConfig, Dict[str, Any], None]) – Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

  • workmail_action (Union[WorkmailActionConfig, Dict[str, Any], None]) – Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ses as ses

receipt_rule_action_config = ses.ReceiptRuleActionConfig(
    add_header_action=ses.AddHeaderActionConfig(
        header_name="headerName",
        header_value="headerValue"
    ),
    bounce_action=ses.BounceActionConfig(
        message="message",
        sender="sender",
        smtp_reply_code="smtpReplyCode",

        # the properties below are optional
        status_code="statusCode",
        topic_arn="topicArn"
    ),
    lambda_action=ses.LambdaActionConfig(
        function_arn="functionArn",

        # the properties below are optional
        invocation_type="invocationType",
        topic_arn="topicArn"
    ),
    s3_action=ses.S3ActionConfig(
        bucket_name="bucketName",

        # the properties below are optional
        kms_key_arn="kmsKeyArn",
        object_key_prefix="objectKeyPrefix",
        topic_arn="topicArn"
    ),
    sns_action=ses.SNSActionConfig(
        encoding="encoding",
        topic_arn="topicArn"
    ),
    stop_action=ses.StopActionConfig(
        scope="scope",

        # the properties below are optional
        topic_arn="topicArn"
    ),
    workmail_action=ses.WorkmailActionConfig(
        organization_arn="organizationArn",

        # the properties below are optional
        topic_arn="topicArn"
    )
)

Attributes

add_header_action

Adds a header to the received email.

Return type

Optional[AddHeaderActionConfig]

bounce_action

Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon SNS.

Return type

Optional[BounceActionConfig]

lambda_action

Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

Return type

Optional[LambdaActionConfig]

s3_action

Saves the received message to an Amazon S3 bucket and, optionally, publishes a notification to Amazon SNS.

Return type

Optional[S3ActionConfig]

sns_action

Publishes the email content within a notification to Amazon SNS.

Return type

Optional[SNSActionConfig]

stop_action

Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

Return type

Optional[StopActionConfig]

workmail_action

Calls Amazon WorkMail and, optionally, publishes a notification to Amazon SNS.

Return type

Optional[WorkmailActionConfig]