Package software.amazon.awscdk.services.ses

Interface CfnReceiptRule.StopActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnReceiptRule.StopActionProperty.Jsii$Proxy

Enclosing class:

CfnReceiptRule

@Stability(Stable)
public static interface CfnReceiptRule.StopActionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ses.*;
 StopActionProperty stopActionProperty = StopActionProperty.builder()
         .scope("scope")
         // the properties below are optional
         .topicArn("topicArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnReceiptRule.StopActionProperty.Builder	A builder for CfnReceiptRule.StopActionProperty
static final class	CfnReceiptRule.StopActionProperty.Jsii$Proxy	An implementation for CfnReceiptRule.StopActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnReceiptRule.StopActionProperty.Builder	builder()
String	getScope()	The scope of the StopAction.
default String	getTopicArn()	The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScope

@Stability(Stable)
@NotNull
String getScope()

The scope of the StopAction.

The only acceptable value is RuleSet .

getTopicArn

@Stability(Stable)
@Nullable
default String getTopicArn()

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 .

builder

@Stability(Stable)
static CfnReceiptRule.StopActionProperty.Builder builder()

Returns:

a CfnReceiptRule.StopActionProperty.Builder of CfnReceiptRule.StopActionProperty