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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb

Overview

Note:

When making an API call, you may pass CognitoStreams data as a hash:

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

Configuration options for configure Cognito streams.

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)


80
81
82
83
84
85
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 80

class CognitoStreams < Struct.new(
  :stream_name,
  :role_arn,
  :streaming_status)
  include Aws::Structure
end

#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)


80
81
82
83
84
85
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 80

class CognitoStreams < Struct.new(
  :stream_name,
  :role_arn,
  :streaming_status)
  include Aws::Structure
end

#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.

Returns:

  • (String)


80
81
82
83
84
85
# File 'gems/aws-sdk-cognitosync/lib/aws-sdk-cognitosync/types.rb', line 80

class CognitoStreams < Struct.new(
  :stream_name,
  :role_arn,
  :streaming_status)
  include Aws::Structure
end