Struct CognitoStreams 

#[non_exhaustive]
pub struct CognitoStreams {
    pub stream_name: Option<String>,
    pub role_arn: Option<String>,
    pub streaming_status: Option<StreamingStatus>,
}

Configuration options for configure Cognito streams.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

stream_name: Option<String>

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.

role_arn: Option<String>

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.

streaming_status: Option<StreamingStatus>

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.

Implementations

impl CognitoStreams

pub fn stream_name(&self) -> Option<&str>

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.

pub fn role_arn(&self) -> Option<&str>

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.

pub fn streaming_status(&self) -> Option<&StreamingStatus>

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.

impl CognitoStreams

pub fn builder() -> CognitoStreamsBuilder

Creates a new builder-style object to manufacture CognitoStreams.

Trait Implementations

impl Clone for CognitoStreams

fn clone(&self) -> CognitoStreams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CognitoStreams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CognitoStreams

fn eq(&self, other: &CognitoStreams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CognitoStreams