class Aws::CognitoSync::Types::CognitoStreams

Configuration options for configure Cognito streams.

@note When making an API call, you may pass CognitoStreams

data as a hash:

    {
      stream_name: "StreamName",
      role_arn: "AssumeRoleArn",
      streaming_status: "ENABLED", # accepts ENABLED, DISABLED
    }

@!attribute [rw] stream_name

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.
@return [String]

@!attribute [rw] role_arn

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.
@return [String]

@!attribute [rw] streaming_status

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.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/cognito-sync-2014-06-30/CognitoStreams AWS API Documentation

Constants

SENSITIVE