AWS::Cognito::IdentityPool CognitoStreams
CognitoStreams
is a property of the AWS::Cognito::IdentityPool resource that defines configuration options for
Amazon Cognito streams.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following 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.Required: No
Type: String
Update requires: No interruption
StreamingStatus
-
Status of the Amazon Cognito streams. Valid values are:
ENABLED
orDISABLED
.Required: No
Type: String
Update requires: No interruption
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.
Required: No
Type: String
Update requires: No interruption