AWS SDK for C++  1.8.182
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoT::Model::SnsAction Class Reference

#include <SnsAction.h>

Public Member Functions

 SnsAction ()
 
 SnsAction (Aws::Utils::Json::JsonView jsonValue)
 
SnsActionoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetTargetArn () const
 
bool TargetArnHasBeenSet () const
 
void SetTargetArn (const Aws::String &value)
 
void SetTargetArn (Aws::String &&value)
 
void SetTargetArn (const char *value)
 
SnsActionWithTargetArn (const Aws::String &value)
 
SnsActionWithTargetArn (Aws::String &&value)
 
SnsActionWithTargetArn (const char *value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
SnsActionWithRoleArn (const Aws::String &value)
 
SnsActionWithRoleArn (Aws::String &&value)
 
SnsActionWithRoleArn (const char *value)
 
const MessageFormatGetMessageFormat () const
 
bool MessageFormatHasBeenSet () const
 
void SetMessageFormat (const MessageFormat &value)
 
void SetMessageFormat (MessageFormat &&value)
 
SnsActionWithMessageFormat (const MessageFormat &value)
 
SnsActionWithMessageFormat (MessageFormat &&value)
 

Detailed Description

Describes an action to publish to an Amazon SNS topic.

See Also:

AWS API Reference

Definition at line 33 of file SnsAction.h.

Constructor & Destructor Documentation

◆ SnsAction() [1/2]

Aws::IoT::Model::SnsAction::SnsAction ( )

◆ SnsAction() [2/2]

Aws::IoT::Model::SnsAction::SnsAction ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetMessageFormat()

const MessageFormat& Aws::IoT::Model::SnsAction::GetMessageFormat ( ) const
inline

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Definition at line 133 of file SnsAction.h.

◆ GetRoleArn()

const Aws::String& Aws::IoT::Model::SnsAction::GetRoleArn ( ) const
inline

The ARN of the IAM role that grants access.

Definition at line 86 of file SnsAction.h.

◆ GetTargetArn()

const Aws::String& Aws::IoT::Model::SnsAction::GetTargetArn ( ) const
inline

The ARN of the SNS topic.

Definition at line 45 of file SnsAction.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoT::Model::SnsAction::Jsonize ( ) const

◆ MessageFormatHasBeenSet()

bool Aws::IoT::Model::SnsAction::MessageFormatHasBeenSet ( ) const
inline

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Definition at line 144 of file SnsAction.h.

◆ operator=()

SnsAction& Aws::IoT::Model::SnsAction::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::IoT::Model::SnsAction::RoleArnHasBeenSet ( ) const
inline

The ARN of the IAM role that grants access.

Definition at line 91 of file SnsAction.h.

◆ SetMessageFormat() [1/2]

void Aws::IoT::Model::SnsAction::SetMessageFormat ( const MessageFormat value)
inline

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Definition at line 155 of file SnsAction.h.

◆ SetMessageFormat() [2/2]

void Aws::IoT::Model::SnsAction::SetMessageFormat ( MessageFormat &&  value)
inline

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Definition at line 166 of file SnsAction.h.

◆ SetRoleArn() [1/3]

void Aws::IoT::Model::SnsAction::SetRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM role that grants access.

Definition at line 101 of file SnsAction.h.

◆ SetRoleArn() [2/3]

void Aws::IoT::Model::SnsAction::SetRoleArn ( const Aws::String value)
inline

The ARN of the IAM role that grants access.

Definition at line 96 of file SnsAction.h.

◆ SetRoleArn() [3/3]

void Aws::IoT::Model::SnsAction::SetRoleArn ( const char *  value)
inline

The ARN of the IAM role that grants access.

Definition at line 106 of file SnsAction.h.

◆ SetTargetArn() [1/3]

void Aws::IoT::Model::SnsAction::SetTargetArn ( Aws::String &&  value)
inline

The ARN of the SNS topic.

Definition at line 60 of file SnsAction.h.

◆ SetTargetArn() [2/3]

void Aws::IoT::Model::SnsAction::SetTargetArn ( const Aws::String value)
inline

The ARN of the SNS topic.

Definition at line 55 of file SnsAction.h.

◆ SetTargetArn() [3/3]

void Aws::IoT::Model::SnsAction::SetTargetArn ( const char *  value)
inline

The ARN of the SNS topic.

Definition at line 65 of file SnsAction.h.

◆ TargetArnHasBeenSet()

bool Aws::IoT::Model::SnsAction::TargetArnHasBeenSet ( ) const
inline

The ARN of the SNS topic.

Definition at line 50 of file SnsAction.h.

◆ WithMessageFormat() [1/2]

SnsAction& Aws::IoT::Model::SnsAction::WithMessageFormat ( const MessageFormat value)
inline

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Definition at line 177 of file SnsAction.h.

◆ WithMessageFormat() [2/2]

SnsAction& Aws::IoT::Model::SnsAction::WithMessageFormat ( MessageFormat &&  value)
inline

(Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

Definition at line 188 of file SnsAction.h.

◆ WithRoleArn() [1/3]

SnsAction& Aws::IoT::Model::SnsAction::WithRoleArn ( Aws::String &&  value)
inline

The ARN of the IAM role that grants access.

Definition at line 116 of file SnsAction.h.

◆ WithRoleArn() [2/3]

SnsAction& Aws::IoT::Model::SnsAction::WithRoleArn ( const Aws::String value)
inline

The ARN of the IAM role that grants access.

Definition at line 111 of file SnsAction.h.

◆ WithRoleArn() [3/3]

SnsAction& Aws::IoT::Model::SnsAction::WithRoleArn ( const char *  value)
inline

The ARN of the IAM role that grants access.

Definition at line 121 of file SnsAction.h.

◆ WithTargetArn() [1/3]

SnsAction& Aws::IoT::Model::SnsAction::WithTargetArn ( Aws::String &&  value)
inline

The ARN of the SNS topic.

Definition at line 75 of file SnsAction.h.

◆ WithTargetArn() [2/3]

SnsAction& Aws::IoT::Model::SnsAction::WithTargetArn ( const Aws::String value)
inline

The ARN of the SNS topic.

Definition at line 70 of file SnsAction.h.

◆ WithTargetArn() [3/3]

SnsAction& Aws::IoT::Model::SnsAction::WithTargetArn ( const char *  value)
inline

The ARN of the SNS topic.

Definition at line 80 of file SnsAction.h.


The documentation for this class was generated from the following file: