Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoSync.Types.CognitoStreams

Description

Documentation

data CognitoStreams Source #

Configuration options for configure Cognito streams.

See: newCognitoStreams smart constructor.

Constructors

CognitoStreams'

Fields

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

Instances

Instances details

Eq CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams Methods (==) :: CognitoStreams -> CognitoStreams -> Bool # (/=) :: CognitoStreams -> CognitoStreams -> Bool #
Read CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams Methods readsPrec :: Int -> ReadS CognitoStreams # readList :: ReadS [CognitoStreams] # readPrec :: ReadPrec CognitoStreams # readListPrec :: ReadPrec [CognitoStreams] #
Show CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams Methods showsPrec :: Int -> CognitoStreams -> ShowS # show :: CognitoStreams -> String # showList :: [CognitoStreams] -> ShowS #
Generic CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams Associated Types type Rep CognitoStreams :: Type -> Type # Methods from :: CognitoStreams -> Rep CognitoStreams x # to :: Rep CognitoStreams x -> CognitoStreams #
NFData CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams Methods rnf :: CognitoStreams -> () #
Hashable CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams Methods hashWithSalt :: Int -> CognitoStreams -> Int # hash :: CognitoStreams -> Int #
ToJSON CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams Methods toJSON :: CognitoStreams -> Value # toEncoding :: CognitoStreams -> Encoding # toJSONList :: [CognitoStreams] -> Value # toEncodingList :: [CognitoStreams] -> Encoding #
FromJSON CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams Methods parseJSON :: Value -> Parser CognitoStreams # parseJSONList :: Value -> Parser [CognitoStreams] #
type Rep CognitoStreams Source #
Instance details Defined in Amazonka.CognitoSync.Types.CognitoStreams type Rep CognitoStreams = D1 ('MetaData "CognitoStreams" "Amazonka.CognitoSync.Types.CognitoStreams" "libZSservicesZSamazonka-cognito-syncZSamazonka-cognito-sync" 'False) (C1 ('MetaCons "CognitoStreams'" 'PrefixI 'True) (S1 ('MetaSel ('Just "streamingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingStatus)) :: (S1 ('MetaSel ('Just "streamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCognitoStreams :: CognitoStreams Source #

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

$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: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.

cognitoStreams_streamingStatus :: Lens' CognitoStreams (Maybe StreamingStatus) Source #

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_streamName :: Lens' CognitoStreams (Maybe Text) Source #

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_roleArn :: Lens' CognitoStreams (Maybe Text) Source #

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.