AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoSync::Types::CognitoStreams

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CognitoStreams as input to an Aws::Client method, you can use a vanilla Hash:

{
  stream_name: "StreamName",
  role_arn: "AssumeRoleArn",
  streaming_status: "ENABLED", # accepts ENABLED, DISABLED
}

Configuration options for configure Cognito streams.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#role_arnString

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Returns:

  • (String)

    The ARN of the role Amazon Cognito can assume in order to publish to the stream.

#stream_nameString

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Returns:

  • (String)

    The name of the Cognito stream to receive updates.

#streaming_statusString

Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String)

    Status of the Cognito streams.