CognitoStreamsProperty Struct
CognitoStreams is a property of the AWS::Cognito::IdentityPool resource that defines configuration options for Amazon Cognito streams.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const cognitoStreamsProperty: cognito.CfnIdentityPool.CognitoStreamsProperty = {
roleArn: 'roleArn',
streamingStatus: 'streamingStatus',
streamName: 'streamName',
};
Properties
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*string#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.
streamingStatusoptionalstringstreaming_statusoptionalstrstreamingStatusoptionalStringStreamingStatusoptionalstringStreamingStatusoptional*string#Status of the Amazon Cognito streams.
Valid values are: ENABLED or DISABLED .
streamNameoptionalstringstream_nameoptionalstrstreamNameoptionalStringStreamNameoptionalstringStreamNameoptional*string#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.