aws-cdk-lib.aws_ses.CfnReceiptRule.BounceActionProperty

interface BounceActionProperty

LanguageType name
.NETAmazon.CDK.AWS.SES.CfnReceiptRule.BounceActionProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#CfnReceiptRule_BounceActionProperty
Javasoftware.amazon.awscdk.services.ses.CfnReceiptRule.BounceActionProperty
Pythonaws_cdk.aws_ses.CfnReceiptRule.BounceActionProperty
TypeScript aws-cdk-lib » aws_ses » CfnReceiptRule » BounceActionProperty

When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
const bounceActionProperty: ses.CfnReceiptRule.BounceActionProperty = {
  message: 'message',
  sender: 'sender',
  smtpReplyCode: 'smtpReplyCode',

  // the properties below are optional
  statusCode: 'statusCode',
  topicArn: 'topicArn',
};

Properties

NameTypeDescription
messagestringHuman-readable text to include in the bounce message.
senderstringThe email address of the sender of the bounced email.
smtpReplyCodestringThe SMTP reply code, as defined by RFC 5321 .
statusCode?stringThe SMTP enhanced status code, as defined by RFC 3463 .
topicArn?stringThe Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.

message

Type: string

Human-readable text to include in the bounce message.


sender

Type: string

The email address of the sender of the bounced email.

This is the address from which the bounce message is sent.


smtpReplyCode

Type: string

The SMTP reply code, as defined by RFC 5321 .


statusCode?

Type: string (optional)

The SMTP enhanced status code, as defined by RFC 3463 .


topicArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken.

You can find the ARN of a topic by using the ListTopics operation in Amazon SNS.

For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .