Class StopAction
- java.lang.Object
-
- com.amazonaws.services.simpleemail.model.StopAction
-
- All Implemented Interfaces:
Serializable
,Cloneable
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.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description StopAction()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.
-
-
-
Method Detail
-
setScope
public void setScope(String scope)
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:
StopScope
-
getScope
public String 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:
StopScope
-
withScope
public StopAction withScope(String scope)
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:
StopScope
-
setScope
public void setScope(StopScope scope)
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:
StopScope
-
withScope
public StopAction withScope(StopScope scope)
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:
StopScope
-
setTopicArn
public void setTopicArn(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.- 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
public 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.- 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
public StopAction withTopicArn(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.- 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
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public StopAction clone()
-
-