@Generated(value="software.amazon.awssdk:codegen") public final class StopAction extends Object implements ToCopyableBuilder<StopAction.Builder,StopAction>
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.
Modifier and Type | Class and Description |
---|---|
static interface |
StopAction.Builder |
Modifier and Type | Method and Description |
---|---|
static StopAction.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
StopScope |
scope()
The name of the RuleSet that is being stopped.
|
String |
scopeAsString()
The name of the RuleSet that is being stopped.
|
static Class<? extends StopAction.Builder> |
serializableBuilderClass() |
StopAction.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
topicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.
|
String |
toString() |
copy
public StopScope scope()
The name of the RuleSet that is being stopped.
If the service returns an enum value that is not available in the current SDK version, scope
will return
StopScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
scopeAsString()
.
StopScope
public String scopeAsString()
The name of the RuleSet that is being stopped.
If the service returns an enum value that is not available in the current SDK version, scope
will return
StopScope.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
scopeAsString()
.
StopScope
public String topicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an
Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about
Amazon SNS topics, see the Amazon SNS
Developer Guide.
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon SNS Developer Guide.public StopAction.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StopAction.Builder,StopAction>
public static StopAction.Builder builder()
public static Class<? extends StopAction.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.