Amazonka.CognitoSync.Types.CognitoStreams

Documentation

data CognitoStreams

Configuration options for configure Cognito streams.

See: newCognitoStreams smart constructor.

Constructors

CognitoStreams'

Fields

• roleArn :: Maybe Text

  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.

• streamName :: Maybe Text

  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.

• streamingStatus :: Maybe StreamingStatus

  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.

Instances

FromJSON CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

Methods

parseJSON :: Value -> Parser CognitoStreams

parseJSONList :: Value -> Parser [CognitoStreams]

ToJSON CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

Methods

toJSON :: CognitoStreams -> Value

toEncoding :: CognitoStreams -> Encoding

toJSONList :: [CognitoStreams] -> Value

toEncodingList :: [CognitoStreams] -> Encoding

Generic CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

Associated Types

type Rep CognitoStreams :: Type -> Type

Methods

from :: CognitoStreams -> Rep CognitoStreams x

to :: Rep CognitoStreams x -> CognitoStreams

Read CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

Methods

readsPrec :: Int -> ReadS CognitoStreams

readList :: ReadS [CognitoStreams]

readPrec :: ReadPrec CognitoStreams

readListPrec :: ReadPrec [CognitoStreams]

Show CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

Methods

showsPrec :: Int -> CognitoStreams -> ShowS

show :: CognitoStreams -> String

showList :: [CognitoStreams] -> ShowS

NFData CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

Methods

rnf :: CognitoStreams -> ()

Eq CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

Methods

(==) :: CognitoStreams -> CognitoStreams -> Bool

(/=) :: CognitoStreams -> CognitoStreams -> Bool

Hashable CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

Methods

hashWithSalt :: Int -> CognitoStreams -> Int

hash :: CognitoStreams -> Int

type Rep CognitoStreams

Defined in Amazonka.CognitoSync.Types.CognitoStreams

type Rep CognitoStreams = D1 ('MetaData "CognitoStreams" "Amazonka.CognitoSync.Types.CognitoStreams" "amazonka-cognito-sync-2.0-4eAo0O3jWiUGlkSwv2vKaB" 'False) (C1 ('MetaCons "CognitoStreams'" 'PrefixI 'True) (S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "streamingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingStatus)))))

newCognitoStreams :: CognitoStreams

Create a value of CognitoStreams with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:roleArn:CognitoStreams', cognitoStreams_roleArn - 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.

$sel:streamName:CognitoStreams', cognitoStreams_streamName - 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.

$sel:streamingStatus:CognitoStreams', cognitoStreams_streamingStatus - 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.

cognitoStreams_roleArn :: Lens' CognitoStreams (Maybe Text)

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.

cognitoStreams_streamName :: Lens' CognitoStreams (Maybe Text)

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.

cognitoStreams_streamingStatus :: Lens' CognitoStreams (Maybe StreamingStatus)

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.