Interface CfnIdentityPool.ICognitoStreamsProperty

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

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

public interface CfnIdentityPool.ICognitoStreamsProperty

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"
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html

ExampleMetadata: fixture=_generated

Properties

RoleArn

The Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream.

string? RoleArn { get; }

Property Value

string

Remarks

This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Amazon Cognito stream.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-rolearn

StreamName

The name of the Amazon Cognito stream to receive updates.

string? StreamName { get; }

Property Value

string

Remarks

This stream must be in the developer's account and in the same Region as the identity pool.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamname

StreamingStatus

Status of the Amazon Cognito streams.

string? StreamingStatus { get; }

Property Value

string

Remarks

Valid values are: ENABLED or DISABLED .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-identitypool-cognitostreams.html#cfn-cognito-identitypool-cognitostreams-streamingstatus