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

#include <TopicRuleDestination.h>

Public Member Functions

 TopicRuleDestination ()
 
 TopicRuleDestination (Aws::Utils::Json::JsonView jsonValue)
 
TopicRuleDestinationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetArn () const
 
bool ArnHasBeenSet () const
 
void SetArn (const Aws::String &value)
 
void SetArn (Aws::String &&value)
 
void SetArn (const char *value)
 
TopicRuleDestinationWithArn (const Aws::String &value)
 
TopicRuleDestinationWithArn (Aws::String &&value)
 
TopicRuleDestinationWithArn (const char *value)
 
const TopicRuleDestinationStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const TopicRuleDestinationStatus &value)
 
void SetStatus (TopicRuleDestinationStatus &&value)
 
TopicRuleDestinationWithStatus (const TopicRuleDestinationStatus &value)
 
TopicRuleDestinationWithStatus (TopicRuleDestinationStatus &&value)
 
const Aws::Utils::DateTimeGetCreatedAt () const
 
bool CreatedAtHasBeenSet () const
 
void SetCreatedAt (const Aws::Utils::DateTime &value)
 
void SetCreatedAt (Aws::Utils::DateTime &&value)
 
TopicRuleDestinationWithCreatedAt (const Aws::Utils::DateTime &value)
 
TopicRuleDestinationWithCreatedAt (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastUpdatedAt () const
 
bool LastUpdatedAtHasBeenSet () const
 
void SetLastUpdatedAt (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedAt (Aws::Utils::DateTime &&value)
 
TopicRuleDestinationWithLastUpdatedAt (const Aws::Utils::DateTime &value)
 
TopicRuleDestinationWithLastUpdatedAt (Aws::Utils::DateTime &&value)
 
const Aws::StringGetStatusReason () const
 
bool StatusReasonHasBeenSet () const
 
void SetStatusReason (const Aws::String &value)
 
void SetStatusReason (Aws::String &&value)
 
void SetStatusReason (const char *value)
 
TopicRuleDestinationWithStatusReason (const Aws::String &value)
 
TopicRuleDestinationWithStatusReason (Aws::String &&value)
 
TopicRuleDestinationWithStatusReason (const char *value)
 
const HttpUrlDestinationPropertiesGetHttpUrlProperties () const
 
bool HttpUrlPropertiesHasBeenSet () const
 
void SetHttpUrlProperties (const HttpUrlDestinationProperties &value)
 
void SetHttpUrlProperties (HttpUrlDestinationProperties &&value)
 
TopicRuleDestinationWithHttpUrlProperties (const HttpUrlDestinationProperties &value)
 
TopicRuleDestinationWithHttpUrlProperties (HttpUrlDestinationProperties &&value)
 
const VpcDestinationPropertiesGetVpcProperties () const
 
bool VpcPropertiesHasBeenSet () const
 
void SetVpcProperties (const VpcDestinationProperties &value)
 
void SetVpcProperties (VpcDestinationProperties &&value)
 
TopicRuleDestinationWithVpcProperties (const VpcDestinationProperties &value)
 
TopicRuleDestinationWithVpcProperties (VpcDestinationProperties &&value)
 

Detailed Description

A topic rule destination.

See Also:

AWS API Reference

Definition at line 35 of file TopicRuleDestination.h.

Constructor & Destructor Documentation

◆ TopicRuleDestination() [1/2]

Aws::IoT::Model::TopicRuleDestination::TopicRuleDestination ( )

◆ TopicRuleDestination() [2/2]

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

Member Function Documentation

◆ ArnHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestination::ArnHasBeenSet ( ) const
inline

The topic rule destination URL.

Definition at line 52 of file TopicRuleDestination.h.

◆ CreatedAtHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestination::CreatedAtHasBeenSet ( ) const
inline

The date and time when the topic rule destination was created.

Definition at line 226 of file TopicRuleDestination.h.

◆ GetArn()

const Aws::String& Aws::IoT::Model::TopicRuleDestination::GetArn ( ) const
inline

The topic rule destination URL.

Definition at line 47 of file TopicRuleDestination.h.

◆ GetCreatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::TopicRuleDestination::GetCreatedAt ( ) const
inline

The date and time when the topic rule destination was created.

Definition at line 221 of file TopicRuleDestination.h.

◆ GetHttpUrlProperties()

const HttpUrlDestinationProperties& Aws::IoT::Model::TopicRuleDestination::GetHttpUrlProperties ( ) const
inline

Properties of the HTTP URL.

Definition at line 332 of file TopicRuleDestination.h.

◆ GetLastUpdatedAt()

const Aws::Utils::DateTime& Aws::IoT::Model::TopicRuleDestination::GetLastUpdatedAt ( ) const
inline

The date and time when the topic rule destination was last updated.

Definition at line 252 of file TopicRuleDestination.h.

◆ GetStatus()

const TopicRuleDestinationStatus& Aws::IoT::Model::TopicRuleDestination::GetStatus ( ) const
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 105 of file TopicRuleDestination.h.

◆ GetStatusReason()

const Aws::String& Aws::IoT::Model::TopicRuleDestination::GetStatusReason ( ) const
inline

Additional details or reason why the topic rule destination is in the current status.

Definition at line 284 of file TopicRuleDestination.h.

◆ GetVpcProperties()

const VpcDestinationProperties& Aws::IoT::Model::TopicRuleDestination::GetVpcProperties ( ) const
inline

Properties of the virtual private cloud (VPC) connection.

Definition at line 363 of file TopicRuleDestination.h.

◆ HttpUrlPropertiesHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestination::HttpUrlPropertiesHasBeenSet ( ) const
inline

Properties of the HTTP URL.

Definition at line 337 of file TopicRuleDestination.h.

◆ Jsonize()

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

◆ LastUpdatedAtHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestination::LastUpdatedAtHasBeenSet ( ) const
inline

The date and time when the topic rule destination was last updated.

Definition at line 257 of file TopicRuleDestination.h.

◆ operator=()

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

◆ SetArn() [1/3]

void Aws::IoT::Model::TopicRuleDestination::SetArn ( Aws::String &&  value)
inline

The topic rule destination URL.

Definition at line 62 of file TopicRuleDestination.h.

◆ SetArn() [2/3]

void Aws::IoT::Model::TopicRuleDestination::SetArn ( const Aws::String value)
inline

The topic rule destination URL.

Definition at line 57 of file TopicRuleDestination.h.

◆ SetArn() [3/3]

void Aws::IoT::Model::TopicRuleDestination::SetArn ( const char *  value)
inline

The topic rule destination URL.

Definition at line 67 of file TopicRuleDestination.h.

◆ SetCreatedAt() [1/2]

void Aws::IoT::Model::TopicRuleDestination::SetCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time when the topic rule destination was created.

Definition at line 236 of file TopicRuleDestination.h.

◆ SetCreatedAt() [2/2]

void Aws::IoT::Model::TopicRuleDestination::SetCreatedAt ( const Aws::Utils::DateTime value)
inline

The date and time when the topic rule destination was created.

Definition at line 231 of file TopicRuleDestination.h.

◆ SetHttpUrlProperties() [1/2]

void Aws::IoT::Model::TopicRuleDestination::SetHttpUrlProperties ( const HttpUrlDestinationProperties value)
inline

Properties of the HTTP URL.

Definition at line 342 of file TopicRuleDestination.h.

◆ SetHttpUrlProperties() [2/2]

void Aws::IoT::Model::TopicRuleDestination::SetHttpUrlProperties ( HttpUrlDestinationProperties &&  value)
inline

Properties of the HTTP URL.

Definition at line 347 of file TopicRuleDestination.h.

◆ SetLastUpdatedAt() [1/2]

void Aws::IoT::Model::TopicRuleDestination::SetLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time when the topic rule destination was last updated.

Definition at line 267 of file TopicRuleDestination.h.

◆ SetLastUpdatedAt() [2/2]

void Aws::IoT::Model::TopicRuleDestination::SetLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

The date and time when the topic rule destination was last updated.

Definition at line 262 of file TopicRuleDestination.h.

◆ SetStatus() [1/2]

void Aws::IoT::Model::TopicRuleDestination::SetStatus ( const TopicRuleDestinationStatus value)
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 149 of file TopicRuleDestination.h.

◆ SetStatus() [2/2]

void Aws::IoT::Model::TopicRuleDestination::SetStatus ( TopicRuleDestinationStatus &&  value)
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 171 of file TopicRuleDestination.h.

◆ SetStatusReason() [1/3]

void Aws::IoT::Model::TopicRuleDestination::SetStatusReason ( Aws::String &&  value)
inline

Additional details or reason why the topic rule destination is in the current status.

Definition at line 302 of file TopicRuleDestination.h.

◆ SetStatusReason() [2/3]

void Aws::IoT::Model::TopicRuleDestination::SetStatusReason ( const Aws::String value)
inline

Additional details or reason why the topic rule destination is in the current status.

Definition at line 296 of file TopicRuleDestination.h.

◆ SetStatusReason() [3/3]

void Aws::IoT::Model::TopicRuleDestination::SetStatusReason ( const char *  value)
inline

Additional details or reason why the topic rule destination is in the current status.

Definition at line 308 of file TopicRuleDestination.h.

◆ SetVpcProperties() [1/2]

void Aws::IoT::Model::TopicRuleDestination::SetVpcProperties ( const VpcDestinationProperties value)
inline

Properties of the virtual private cloud (VPC) connection.

Definition at line 373 of file TopicRuleDestination.h.

◆ SetVpcProperties() [2/2]

void Aws::IoT::Model::TopicRuleDestination::SetVpcProperties ( VpcDestinationProperties &&  value)
inline

Properties of the virtual private cloud (VPC) connection.

Definition at line 378 of file TopicRuleDestination.h.

◆ StatusHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestination::StatusHasBeenSet ( ) const
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 127 of file TopicRuleDestination.h.

◆ StatusReasonHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestination::StatusReasonHasBeenSet ( ) const
inline

Additional details or reason why the topic rule destination is in the current status.

Definition at line 290 of file TopicRuleDestination.h.

◆ VpcPropertiesHasBeenSet()

bool Aws::IoT::Model::TopicRuleDestination::VpcPropertiesHasBeenSet ( ) const
inline

Properties of the virtual private cloud (VPC) connection.

Definition at line 368 of file TopicRuleDestination.h.

◆ WithArn() [1/3]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithArn ( Aws::String &&  value)
inline

The topic rule destination URL.

Definition at line 77 of file TopicRuleDestination.h.

◆ WithArn() [2/3]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithArn ( const Aws::String value)
inline

The topic rule destination URL.

Definition at line 72 of file TopicRuleDestination.h.

◆ WithArn() [3/3]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithArn ( const char *  value)
inline

The topic rule destination URL.

Definition at line 82 of file TopicRuleDestination.h.

◆ WithCreatedAt() [1/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithCreatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time when the topic rule destination was created.

Definition at line 246 of file TopicRuleDestination.h.

◆ WithCreatedAt() [2/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithCreatedAt ( const Aws::Utils::DateTime value)
inline

The date and time when the topic rule destination was created.

Definition at line 241 of file TopicRuleDestination.h.

◆ WithHttpUrlProperties() [1/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithHttpUrlProperties ( const HttpUrlDestinationProperties value)
inline

Properties of the HTTP URL.

Definition at line 352 of file TopicRuleDestination.h.

◆ WithHttpUrlProperties() [2/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithHttpUrlProperties ( HttpUrlDestinationProperties &&  value)
inline

Properties of the HTTP URL.

Definition at line 357 of file TopicRuleDestination.h.

◆ WithLastUpdatedAt() [1/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithLastUpdatedAt ( Aws::Utils::DateTime &&  value)
inline

The date and time when the topic rule destination was last updated.

Definition at line 277 of file TopicRuleDestination.h.

◆ WithLastUpdatedAt() [2/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithLastUpdatedAt ( const Aws::Utils::DateTime value)
inline

The date and time when the topic rule destination was last updated.

Definition at line 272 of file TopicRuleDestination.h.

◆ WithStatus() [1/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithStatus ( const TopicRuleDestinationStatus value)
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 193 of file TopicRuleDestination.h.

◆ WithStatus() [2/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithStatus ( TopicRuleDestinationStatus &&  value)
inline

The status of the topic rule destination. Valid values are:

IN_PROGRESS

A topic rule destination was created but has not been confirmed. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

ENABLED

Confirmation was completed, and traffic to this destination is allowed. You can set status to DISABLED by calling UpdateTopicRuleDestination.

DISABLED

Confirmation was completed, and traffic to this destination is not allowed. You can set status to ENABLED by calling UpdateTopicRuleDestination.

ERROR

Confirmation could not be completed, for example if the confirmation timed out. You can call GetTopicRuleDestination for details about the error. You can set status to IN_PROGRESS by calling UpdateTopicRuleDestination. Calling UpdateTopicRuleDestination causes a new confirmation challenge to be sent to your confirmation endpoint.

Definition at line 215 of file TopicRuleDestination.h.

◆ WithStatusReason() [1/3]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithStatusReason ( Aws::String &&  value)
inline

Additional details or reason why the topic rule destination is in the current status.

Definition at line 320 of file TopicRuleDestination.h.

◆ WithStatusReason() [2/3]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithStatusReason ( const Aws::String value)
inline

Additional details or reason why the topic rule destination is in the current status.

Definition at line 314 of file TopicRuleDestination.h.

◆ WithStatusReason() [3/3]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithStatusReason ( const char *  value)
inline

Additional details or reason why the topic rule destination is in the current status.

Definition at line 326 of file TopicRuleDestination.h.

◆ WithVpcProperties() [1/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithVpcProperties ( const VpcDestinationProperties value)
inline

Properties of the virtual private cloud (VPC) connection.

Definition at line 383 of file TopicRuleDestination.h.

◆ WithVpcProperties() [2/2]

TopicRuleDestination& Aws::IoT::Model::TopicRuleDestination::WithVpcProperties ( VpcDestinationProperties &&  value)
inline

Properties of the virtual private cloud (VPC) connection.

Definition at line 388 of file TopicRuleDestination.h.


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