Package software.amazon.awssdk.services.ses.model

Class StopAction

java.lang.Object

software.amazon.awssdk.services.ses.model.StopAction

All Implemented Interfaces:

ToCopyableBuilder<StopAction.Builder,StopAction>

@Generated("software.amazon.awssdk:codegen")
public 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StopAction.Builder

Method Summary

Modifier and Type	Method	Description
static StopAction.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
String	scope()	The scope to which the Stop action applies.
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()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

scope

public String scope()

The scope to which the Stop action applies. That is, what is being stopped.

Returns:

The scope to which the Stop action applies. That is, what is being stopped.

See Also:

StopScope

topicArn

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.

Returns:

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.

toBuilder

public StopAction.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<StopAction.Builder,StopAction>

Returns:

a builder for type T

builder

public static StopAction.Builder builder()

serializableBuilderClass

public static Class<? extends StopAction.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object