Interface CfnIdentityPool.ICognitoStreamsProperty
CognitoStreams
is a property of the AWS::Cognito::IdentityPool resource that defines configuration options for Amazon Cognito streams.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface ICognitoStreamsProperty
Syntax (vb)
Public Interface ICognitoStreamsProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var cognitoStreamsProperty = new CognitoStreamsProperty {
RoleArn = "roleArn",
StreamingStatus = "streamingStatus",
StreamName = "streamName"
};
Synopsis
Properties
RoleArn | The Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream. |
StreamingStatus | Status of the Amazon Cognito streams. |
StreamName | The name of the Amazon Cognito stream to receive updates. |
Properties
RoleArn
The Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream.
virtual string RoleArn { get; }
Property Value
System.String
Remarks
This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord
on your Amazon Cognito stream.
StreamingStatus
Status of the Amazon Cognito streams.
virtual string StreamingStatus { get; }
Property Value
System.String
Remarks
Valid values are: ENABLED
or DISABLED
.
StreamName
The name of the Amazon Cognito stream to receive updates.
virtual string StreamName { get; }
Property Value
System.String
Remarks
This stream must be in the developer's account and in the same Region as the identity pool.