Interface CfnIdentityPool.CognitoStreamsProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnIdentityPool.CognitoStreamsProperty extends
CognitoStreams is a property of the AWS::Cognito::IdentityPool resource that defines configuration options for Amazon Cognito streams.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CognitoStreamsProperty cognitoStreamsProperty = CognitoStreamsProperty.builder()
  • Method Details

    • getRoleArn

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) @Nullable default String getStreamingStatus()
      Status of the Amazon Cognito streams.

      Valid values are: ENABLED or DISABLED .

    • getStreamName

      @Stability(Stable) @Nullable default 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

      @Stability(Stable) static CfnIdentityPool.CognitoStreamsProperty.Builder builder()
      a CfnIdentityPool.CognitoStreamsProperty.Builder of CfnIdentityPool.CognitoStreamsProperty