Menu
Amazon Cognito Sync
API Reference (API Version 2014-06-30)

CognitoStreams

Configuration options for configure Cognito streams.

Contents

DisabledReason

A string containing the reason why streaming of updates to the identity pool was disabled.

Type: String

Required: No

RoleArn

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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:iam::\d+:role/.*

Required: No

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.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

StreamName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: