amazonka-pipes-2.0: Amazon EventBridge Pipes SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Description

 
Synopsis

Documentation

data PipeSourceManagedStreamingKafkaParameters Source #

The parameters for using an MSK stream as a source.

See: newPipeSourceManagedStreamingKafkaParameters smart constructor.

Constructors

PipeSourceManagedStreamingKafkaParameters' 

Fields

Instances

Instances details
FromJSON PipeSourceManagedStreamingKafkaParameters Source # 
Instance details

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

parseJSON :: Value -> Parser PipeSourceManagedStreamingKafkaParameters #

parseJSONList :: Value -> Parser [PipeSourceManagedStreamingKafkaParameters] #

ToJSON PipeSourceManagedStreamingKafkaParameters Source # 
Instance details

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

toJSON :: PipeSourceManagedStreamingKafkaParameters -> Value #

toEncoding :: PipeSourceManagedStreamingKafkaParameters -> Encoding #

toJSONList :: [PipeSourceManagedStreamingKafkaParameters] -> Value #

toEncodingList :: [PipeSourceManagedStreamingKafkaParameters] -> Encoding #

Generic PipeSourceManagedStreamingKafkaParameters Source # 
Instance details

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Associated Types

type Rep PipeSourceManagedStreamingKafkaParameters :: Type -> Type #

Methods

from :: PipeSourceManagedStreamingKafkaParameters -> Rep PipeSourceManagedStreamingKafkaParameters x #

to :: Rep PipeSourceManagedStreamingKafkaParameters x -> PipeSourceManagedStreamingKafkaParameters #

Show PipeSourceManagedStreamingKafkaParameters Source # 
Instance details

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

showsPrec :: Int -> PipeSourceManagedStreamingKafkaParameters -> ShowS #

show :: PipeSourceManagedStreamingKafkaParameters -> String #

showList :: [PipeSourceManagedStreamingKafkaParameters] -> ShowS #

NFData PipeSourceManagedStreamingKafkaParameters Source # 
Instance details

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

rnf :: PipeSourceManagedStreamingKafkaParameters -> () #

Eq PipeSourceManagedStreamingKafkaParameters Source # 
Instance details

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

(==) :: PipeSourceManagedStreamingKafkaParameters -> PipeSourceManagedStreamingKafkaParameters -> Bool #

(/=) :: PipeSourceManagedStreamingKafkaParameters -> PipeSourceManagedStreamingKafkaParameters -> Bool #

Hashable PipeSourceManagedStreamingKafkaParameters Source # 
Instance details

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

Methods

hashWithSalt :: Int -> PipeSourceManagedStreamingKafkaParameters -> Int #

hash :: PipeSourceManagedStreamingKafkaParameters -> Int #

type Rep PipeSourceManagedStreamingKafkaParameters Source # 
Instance details

Defined in Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters

type Rep PipeSourceManagedStreamingKafkaParameters = D1 ('MetaData "PipeSourceManagedStreamingKafkaParameters" "Amazonka.Pipes.Types.PipeSourceManagedStreamingKafkaParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeSourceManagedStreamingKafkaParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "batchSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "consumerGroupID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MSKAccessCredentials)))) :*: (S1 ('MetaSel ('Just "maximumBatchingWindowInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "startingPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MSKStartPosition)) :*: S1 ('MetaSel ('Just "topicName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newPipeSourceManagedStreamingKafkaParameters Source #

Arguments

:: Text

$sel:topicName:PipeSourceManagedStreamingKafkaParameters'

-> PipeSourceManagedStreamingKafkaParameters 

Create a value of PipeSourceManagedStreamingKafkaParameters 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:batchSize:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_batchSize - The maximum number of records to include in each batch.

$sel:consumerGroupID:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_consumerGroupID - The name of the destination queue to consume.

$sel:credentials:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_credentials - The credentials needed to access the resource.

$sel:maximumBatchingWindowInSeconds:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.

$sel:startingPosition:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_startingPosition - (Streams only) The position in a stream from which to start reading.

$sel:topicName:PipeSourceManagedStreamingKafkaParameters', pipeSourceManagedStreamingKafkaParameters_topicName - The name of the topic that the pipe will read from.

pipeSourceManagedStreamingKafkaParameters_batchSize :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Natural) Source #

The maximum number of records to include in each batch.

pipeSourceManagedStreamingKafkaParameters_consumerGroupID :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Text) Source #

The name of the destination queue to consume.

pipeSourceManagedStreamingKafkaParameters_credentials :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe MSKAccessCredentials) Source #

The credentials needed to access the resource.

pipeSourceManagedStreamingKafkaParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe Natural) Source #

The maximum length of a time to wait for events.

pipeSourceManagedStreamingKafkaParameters_startingPosition :: Lens' PipeSourceManagedStreamingKafkaParameters (Maybe MSKStartPosition) Source #

(Streams only) The position in a stream from which to start reading.

pipeSourceManagedStreamingKafkaParameters_topicName :: Lens' PipeSourceManagedStreamingKafkaParameters Text Source #

The name of the topic that the pipe will read from.