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

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

Overview

Configuration options for configure Cognito streams.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#role_arn ⇒ String

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) 


84
85
86
87
88
89
90
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 84

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

#stream_name ⇒ String

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) 


84
85
86
87
88
89
90
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 84

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

#streaming_status ⇒ String

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) 


84
85
86
87
88
89
90
 
# File 'lib/aws-sdk-cognitosync/types.rb', line 84

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