Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Cognito Resource Types Reference » AWS::Cognito::IdentityPool » Amazon Cognito IdentityPool CognitoStreams

Amazon Cognito IdentityPool CognitoStreams

CognitoStreams is a property of the AWS::Cognito::IdentityPool resource that defines configuration options for Amazon Cognito streams.

Syntax

JSON

{
  "RoleArn" : String,
  "StreamingStatus" : String,
  "StreamName" : String
}

YAML

RoleArn: String
StreamingStatus: String
StreamName: String

Properties

RoleArn

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

Type: String

Required: No

StreamingStatus

Status of the Cognito streams. Valid values are: ENABLED or DISABLED.

Type: String

Required: No

StreamName

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

Type: String

Required: No

On this page: