Class StopAction
- All Implemented Interfaces:
Serializable
,Cloneable
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.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
getScope()
The scope to which the Stop action applies.The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.int
hashCode()
void
The scope to which the Stop action applies.void
The scope to which the Stop action applies.void
setTopicArn
(String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.toString()
Returns a string representation of this object; useful for testing and debugging.The scope to which the Stop action applies.The scope to which the Stop action applies.withTopicArn
(String topicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken.
-
Constructor Details
-
StopAction
public StopAction()
-
-
Method Details
-
setScope
The scope to which the Stop action applies. That is, what is being stopped.
- Parameters:
scope
- The scope to which the Stop action applies. That is, what is being stopped.- See Also:
-
getScope
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:
-
withScope
The scope to which the Stop action applies. That is, what is being stopped.
- Parameters:
scope
- The scope to which the Stop action applies. That is, what is being stopped.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setScope
The scope to which the Stop action applies. That is, what is being stopped.
- Parameters:
scope
- The scope to which the Stop action applies. That is, what is being stopped.- See Also:
-
withScope
The scope to which the Stop action applies. That is, what is being stopped.
- Parameters:
scope
- The scope to which the Stop action applies. That is, what is being stopped.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setTopicArn
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.- Parameters:
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 isarn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.
-
getTopicArn
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.
-
withTopicArn
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.- Parameters:
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 isarn:aws:sns:us-west-2:123456789012:MyTopic
. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-