AWS SDK for C++  1.8.79
AWS SDK for C++
Public Member Functions | List of all members
Aws::CognitoSync::Model::CognitoStreams Class Reference

#include <CognitoStreams.h>

Public Member Functions

 CognitoStreams ()
 
 CognitoStreams (Aws::Utils::Json::JsonView jsonValue)
 
CognitoStreamsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetStreamName () const
 
bool StreamNameHasBeenSet () const
 
void SetStreamName (const Aws::String &value)
 
void SetStreamName (Aws::String &&value)
 
void SetStreamName (const char *value)
 
CognitoStreamsWithStreamName (const Aws::String &value)
 
CognitoStreamsWithStreamName (Aws::String &&value)
 
CognitoStreamsWithStreamName (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)
 
CognitoStreamsWithRoleArn (const Aws::String &value)
 
CognitoStreamsWithRoleArn (Aws::String &&value)
 
CognitoStreamsWithRoleArn (const char *value)
 
const StreamingStatusGetStreamingStatus () const
 
bool StreamingStatusHasBeenSet () const
 
void SetStreamingStatus (const StreamingStatus &value)
 
void SetStreamingStatus (StreamingStatus &&value)
 
CognitoStreamsWithStreamingStatus (const StreamingStatus &value)
 
CognitoStreamsWithStreamingStatus (StreamingStatus &&value)
 

Detailed Description

Configuration options for configure Cognito streams.

See Also:

AWS API Reference

Definition at line 32 of file CognitoStreams.h.

Constructor & Destructor Documentation

◆ CognitoStreams() [1/2]

Aws::CognitoSync::Model::CognitoStreams::CognitoStreams ( )

◆ CognitoStreams() [2/2]

Aws::CognitoSync::Model::CognitoStreams::CognitoStreams ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ GetRoleArn()

const Aws::String& Aws::CognitoSync::Model::CognitoStreams::GetRoleArn ( ) const
inline

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Definition at line 95 of file CognitoStreams.h.

◆ GetStreamingStatus()

const StreamingStatus& Aws::CognitoSync::Model::CognitoStreams::GetStreamingStatus ( ) const
inline

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

Definition at line 153 of file CognitoStreams.h.

◆ GetStreamName()

const Aws::String& Aws::CognitoSync::Model::CognitoStreams::GetStreamName ( ) const
inline

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Definition at line 45 of file CognitoStreams.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::CognitoSync::Model::CognitoStreams::Jsonize ( ) const

◆ operator=()

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::CognitoSync::Model::CognitoStreams::RoleArnHasBeenSet ( ) const
inline

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Definition at line 102 of file CognitoStreams.h.

◆ SetRoleArn() [1/3]

void Aws::CognitoSync::Model::CognitoStreams::SetRoleArn ( const Aws::String value)
inline

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Definition at line 109 of file CognitoStreams.h.

◆ SetRoleArn() [2/3]

void Aws::CognitoSync::Model::CognitoStreams::SetRoleArn ( Aws::String &&  value)
inline

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Definition at line 116 of file CognitoStreams.h.

◆ SetRoleArn() [3/3]

void Aws::CognitoSync::Model::CognitoStreams::SetRoleArn ( const char *  value)
inline

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Definition at line 123 of file CognitoStreams.h.

◆ SetStreamingStatus() [1/2]

void Aws::CognitoSync::Model::CognitoStreams::SetStreamingStatus ( const StreamingStatus value)
inline

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

Definition at line 169 of file CognitoStreams.h.

◆ SetStreamingStatus() [2/2]

void Aws::CognitoSync::Model::CognitoStreams::SetStreamingStatus ( StreamingStatus &&  value)
inline

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

Definition at line 177 of file CognitoStreams.h.

◆ SetStreamName() [1/3]

void Aws::CognitoSync::Model::CognitoStreams::SetStreamName ( const Aws::String value)
inline

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Definition at line 57 of file CognitoStreams.h.

◆ SetStreamName() [2/3]

void Aws::CognitoSync::Model::CognitoStreams::SetStreamName ( Aws::String &&  value)
inline

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Definition at line 63 of file CognitoStreams.h.

◆ SetStreamName() [3/3]

void Aws::CognitoSync::Model::CognitoStreams::SetStreamName ( const char *  value)
inline

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Definition at line 69 of file CognitoStreams.h.

◆ StreamingStatusHasBeenSet()

bool Aws::CognitoSync::Model::CognitoStreams::StreamingStatusHasBeenSet ( ) const
inline

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

Definition at line 161 of file CognitoStreams.h.

◆ StreamNameHasBeenSet()

bool Aws::CognitoSync::Model::CognitoStreams::StreamNameHasBeenSet ( ) const
inline

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Definition at line 51 of file CognitoStreams.h.

◆ WithRoleArn() [1/3]

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::WithRoleArn ( const Aws::String value)
inline

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Definition at line 130 of file CognitoStreams.h.

◆ WithRoleArn() [2/3]

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::WithRoleArn ( Aws::String &&  value)
inline

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Definition at line 137 of file CognitoStreams.h.

◆ WithRoleArn() [3/3]

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::WithRoleArn ( const char *  value)
inline

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Definition at line 144 of file CognitoStreams.h.

◆ WithStreamingStatus() [1/2]

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::WithStreamingStatus ( const StreamingStatus value)
inline

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

Definition at line 185 of file CognitoStreams.h.

◆ WithStreamingStatus() [2/2]

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::WithStreamingStatus ( StreamingStatus &&  value)
inline

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

Definition at line 193 of file CognitoStreams.h.

◆ WithStreamName() [1/3]

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::WithStreamName ( const Aws::String value)
inline

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Definition at line 75 of file CognitoStreams.h.

◆ WithStreamName() [2/3]

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::WithStreamName ( Aws::String &&  value)
inline

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Definition at line 81 of file CognitoStreams.h.

◆ WithStreamName() [3/3]

CognitoStreams& Aws::CognitoSync::Model::CognitoStreams::WithStreamName ( const char *  value)
inline

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Definition at line 87 of file CognitoStreams.h.


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