public class StopAction extends Object implements 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 .
Constructor and Description |
---|
StopAction() |
Modifier and Type | Method and Description |
---|---|
StopAction |
clone() |
boolean |
equals(Object obj) |
String |
getScope()
The scope to which the Stop action applies.
|
String |
getTopicArn()
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when
the stop action is taken.
|
int |
hashCode() |
void |
setScope(StopScope scope)
The scope to which the Stop action applies.
|
void |
setScope(String scope)
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.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
StopAction |
withScope(StopScope scope)
The scope to which the Stop action applies.
|
StopAction |
withScope(String scope)
The scope to which the Stop action applies.
|
StopAction |
withTopicArn(String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when
the stop action is taken.
|
public String getScope()
Constraints:
Allowed Values: RuleSet
StopScope
public void setScope(String scope)
Constraints:
Allowed Values: RuleSet
scope
- The scope to which the Stop action applies. That is, what is being
stopped.StopScope
public StopAction withScope(String scope)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: RuleSet
scope
- The scope to which the Stop action applies. That is, what is being
stopped.StopScope
public void setScope(StopScope scope)
Constraints:
Allowed Values: RuleSet
scope
- The scope to which the Stop action applies. That is, what is being
stopped.StopScope
public StopAction withScope(StopScope scope)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: RuleSet
scope
- The scope to which the Stop action applies. That is, what is being
stopped.StopScope
public String getTopicArn()
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 void setTopicArn(String topicArn)
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.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.public StopAction withTopicArn(String topicArn)
arn:aws:sns:us-west-2:123456789012:MyTopic
. For more
information about Amazon SNS topics, see the Amazon
SNS Developer Guide.
Returns a reference to this object so that method calls can be chained together.
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.public String toString()
toString
in class Object
Object.toString()
public StopAction clone()
Copyright © 2015. All rights reserved.