/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Utils { namespace Xml { class XmlNode; } // namespace Xml } // namespace Utils namespace SES { namespace Model { /** *

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:

AWS * API Reference

*/ class StopAction { public: AWS_SES_API StopAction(); AWS_SES_API StopAction(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_SES_API StopAction& operator=(const Aws::Utils::Xml::XmlNode& xmlNode); AWS_SES_API void OutputToStream(Aws::OStream& ostream, const char* location, unsigned index, const char* locationValue) const; AWS_SES_API void OutputToStream(Aws::OStream& oStream, const char* location) const; /** *

The scope of the StopAction. The only acceptable value is * RuleSet.

*/ inline const StopScope& GetScope() const{ return m_scope; } /** *

The scope of the StopAction. The only acceptable value is * RuleSet.

*/ inline bool ScopeHasBeenSet() const { return m_scopeHasBeenSet; } /** *

The scope of the StopAction. The only acceptable value is * RuleSet.

*/ inline void SetScope(const StopScope& value) { m_scopeHasBeenSet = true; m_scope = value; } /** *

The scope of the StopAction. The only acceptable value is * RuleSet.

*/ inline void SetScope(StopScope&& value) { m_scopeHasBeenSet = true; m_scope = std::move(value); } /** *

The scope of the StopAction. The only acceptable value is * RuleSet.

*/ inline StopAction& WithScope(const StopScope& value) { SetScope(value); return *this;} /** *

The scope of the StopAction. The only acceptable value is * RuleSet.

*/ inline StopAction& WithScope(StopScope&& value) { SetScope(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::String& GetTopicArn() const{ return m_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.

*/ inline bool TopicArnHasBeenSet() const { return m_topicArnHasBeenSet; } /** *

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.

*/ inline void SetTopicArn(const Aws::String& value) { m_topicArnHasBeenSet = true; m_topicArn = value; } /** *

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.

*/ inline void SetTopicArn(Aws::String&& value) { m_topicArnHasBeenSet = true; m_topicArn = std::move(value); } /** *

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.

*/ inline void SetTopicArn(const char* value) { m_topicArnHasBeenSet = true; m_topicArn.assign(value); } /** *

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.

*/ inline StopAction& WithTopicArn(const Aws::String& value) { SetTopicArn(value); return *this;} /** *

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.

*/ inline StopAction& WithTopicArn(Aws::String&& value) { SetTopicArn(std::move(value)); return *this;} /** *

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.

*/ inline StopAction& WithTopicArn(const char* value) { SetTopicArn(value); return *this;} private: StopScope m_scope; bool m_scopeHasBeenSet = false; Aws::String m_topicArn; bool m_topicArnHasBeenSet = false; }; } // namespace Model } // namespace SES } // namespace Aws