AWS::Cognito::IdentityPool CognitoStreams - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

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 or DISABLED.

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