software.amazon.awscdk.services.cognito

Interface CfnIdentityPool.CognitoStreamsProperty

All Known Implementing Classes:

CfnIdentityPool.CognitoStreamsProperty.Jsii$Proxy

Enclosing class:

CfnIdentityPool

public static interface CfnIdentityPool.CognitoStreamsProperty

`CognitoStreams` is a property of the [AWS::Cognito::IdentityPool](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypool.html) 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 software.amazon.awscdk.services.cognito.*;
 CognitoStreamsProperty cognitoStreamsProperty = CognitoStreamsProperty.builder()
         .roleArn("roleArn")
         .streamingStatus("streamingStatus")
         .streamName("streamName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnIdentityPool.CognitoStreamsProperty.Builder A builder for CfnIdentityPool.CognitoStreamsProperty
static class	CfnIdentityPool.CognitoStreamsProperty.Jsii$Proxy An implementation for CfnIdentityPool.CognitoStreamsProperty

Method Summary

Modifier and Type	Method and Description
static CfnIdentityPool.CognitoStreamsProperty.Builder	builder()
default java.lang.String	getRoleArn() The Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream.
default java.lang.String	getStreamingStatus() Status of the Amazon Cognito streams.
default java.lang.String	getStreamName() The name of the Amazon Cognito stream to receive updates.

Method Detail

getRoleArn

default java.lang.String getRoleArn()

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.

getStreamingStatus

default java.lang.String getStreamingStatus()

Status of the Amazon Cognito streams.

Valid values are: ENABLED or DISABLED .

getStreamName

default java.lang.String getStreamName()

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.

builder

static CfnIdentityPool.CognitoStreamsProperty.Builder builder()

Returns:

a CfnIdentityPool.CognitoStreamsProperty.Builder of CfnIdentityPool.CognitoStreamsProperty