aws-cdk-lib.aws_cognito.CfnIdentityPool.CognitoStreamsProperty

interface CognitoStreamsProperty

LanguageType name
.NETAmazon.CDK.AWS.Cognito.CfnIdentityPool.CognitoStreamsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnIdentityPool_CognitoStreamsProperty
Javasoftware.amazon.awscdk.services.cognito.CfnIdentityPool.CognitoStreamsProperty
Pythonaws_cdk.aws_cognito.CfnIdentityPool.CognitoStreamsProperty
TypeScript aws-cdk-lib » aws_cognito » CfnIdentityPool » CognitoStreamsProperty

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

Example

// 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

NameTypeDescription
roleArn?stringThe Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream.
streamName?stringThe name of the Amazon Cognito stream to receive updates.
streamingStatus?stringStatus of the Amazon Cognito streams.

roleArn?

Type: string (optional)

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.


streamName?

Type: string (optional)

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.


streamingStatus?

Type: string (optional)

Status of the Amazon Cognito streams.

Valid values are: ENABLED or DISABLED .