interface StopActionProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.SES.CfnReceiptRule.StopActionProperty |
 Java | software.amazon.awscdk.services.ses.CfnReceiptRule.StopActionProperty |
 Python | aws_cdk.aws_ses.CfnReceiptRule.StopActionProperty |
 TypeScript | @aws-cdk/aws-ses » CfnReceiptRule » StopActionProperty |
When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
For information about setting a stop action in a receipt rule, 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 * as ses from '@aws-cdk/aws-ses';
const stopActionProperty: ses.CfnReceiptRule.StopActionProperty = {
scope: 'scope',
// the properties below are optional
topicArn: 'topicArn',
};
Properties
| Name | Type | Description |
|---|---|---|
| scope | string | The scope of the StopAction. |
| topic | string | The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. |
scope
Type:
string
The scope of the StopAction.
The only acceptable value is RuleSet .
topicArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.
You can find the ARN of a topic by using the ListTopics Amazon SNS operation.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide .