public class StopAction
extends java.lang.Object
implements java.io.Serializable, java.lang.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.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
scope
The scope to which the Stop action applies.
|
private java.lang.String |
topicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
stop action is taken.
|
Constructor and Description |
---|
StopAction() |
Modifier and Type | Method and Description |
---|---|
StopAction |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getScope()
The scope to which the Stop action applies.
|
java.lang.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(java.lang.String scope)
The scope to which the Stop action applies.
|
void |
setTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
stop action is taken.
|
java.lang.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(java.lang.String scope)
The scope to which the Stop action applies.
|
StopAction |
withTopicArn(java.lang.String topicArn)
The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the
stop action is taken.
|
private java.lang.String scope
The scope to which the Stop action applies. That is, what is being stopped.
private java.lang.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.
public void setScope(java.lang.String scope)
The scope to which the Stop action applies. That is, what is being stopped.
scope
- The scope to which the Stop action applies. That is, what is being
stopped.StopScope
public java.lang.String getScope()
The scope to which the Stop action applies. That is, what is being stopped.
StopScope
public StopAction withScope(java.lang.String scope)
The scope to which the Stop action applies. That is, what is being stopped.
scope
- The scope to which the Stop action applies. That is, what is being
stopped.StopScope
public void setScope(StopScope scope)
The scope to which the Stop action applies. That is, what is being stopped.
scope
- The scope to which the Stop action applies. That is, what is being
stopped.StopScope
public StopAction withScope(StopScope scope)
The scope to which the Stop action applies. That is, what is being stopped.
scope
- The scope to which the Stop action applies. That is, what is being
stopped.StopScope
public void setTopicArn(java.lang.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.
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 java.lang.String 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.
arn:aws:sns:us-west-2:123456789012:MyTopic
.
For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.public StopAction withTopicArn(java.lang.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.
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 java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public StopAction clone()
clone
in class java.lang.Object